This is an archive of the discontinued Mercurial Phabricator instance.

Differential D7870

rust-utils: add `Escaped` trait
ClosedPublic

Authored by Alphare on Jan 14 2020, 12:33 PM.

Details

Reviewers
kevincox
martinvonz
Group Reviewers
hg-reviewers
Commits
rHGaa0fc32ece9e: rust-utils: add `Escaped` trait
Summary

This will be used as a general interface for displaying things to the user.
The upcoming IncludeMatcher will use it to store its patterns in a
user-displayable string.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Alphare created this revision.Jan 14 2020, 12:33 PM
kevincox accepted this revision.Jan 15 2020, 10:16 AM

I'm not convinced PrettyPrint is the best name. I might call it something more to do with escaping instead of "pretty". However I can't think of anything great.

rust/hg-core/src/utils.rs
146
write!(acc, "\\x{:x}", self).unwrap();
Alphare retitled this revision from rust-utils: add `PrettyPrint` trait to rust-utils: add `Escaped` trait.Jan 15 2020, 4:56 PM
Alphare updated this revision to Diff 19320.
Alphare added a comment.Jan 15 2020, 4:56 PM
In D7870#115935, @kevincox wrote:

I'm not convinced PrettyPrint is the best name. I might call it something more to do with escaping instead of "pretty". However I can't think of anything great.

Yeah, I am not convinced either. I've sent a new patch, maybe that's better?

rust/hg-core/src/utils.rs
146

Oh nice!

Alphare updated this revision to Diff 19348.Jan 16 2020, 4:31 AM
kevincox accepted this revision.Jan 16 2020, 7:44 AM

I think it's better. Maybe still a little vauge but I'll let subject experts make that decision.

martinvonz requested changes to this revision.Feb 6 2020, 11:42 AM
martinvonz added a subscriber: martinvonz.

I'm also not sure about the name, but I don't have a better proposal. We can revisit that later when it's clearer how it will be used.

rust/hg-core/src/utils.rs
154–157

i.e. self.iter().flat_map(|item| item.escaped_bytes()).collect()?

This revision now requires changes to proceed.Feb 6 2020, 11:42 AM
Alphare added inline comments.Feb 6 2020, 11:45 AM
rust/hg-core/src/utils.rs
154–157

Sometimes I forget about flat_map. Thanks!

Alphare updated this revision to Diff 19958.Feb 6 2020, 11:47 AM
Alphare added a commit: rHGaa0fc32ece9e: rust-utils: add `Escaped` trait.Feb 6 2020, 12:04 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHGaa0fc32ece9e: rust-utils: add `Escaped` trait (authored by Alphare). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mrust/hg-core/src/utils.rs (54 lines)

Diff 19964

rust/hg-core/src/utils.rs

// utils module // utils module
// //
// Copyright 2019 Raphaël Gomès <rgomes@octobus.net> // Copyright 2019 Raphaël Gomès <rgomes@octobus.net>
// //
// This software may be used and distributed according to the terms of the // This software may be used and distributed according to the terms of the
// GNU General Public License version 2 or any later version. // GNU General Public License version 2 or any later version.
//! Contains useful functions, traits, structs, etc. for use in core. //! Contains useful functions, traits, structs, etc. for use in core.
use crate::utils::hg_path::HgPath;
use std::{io::Write, ops::Deref};
pub mod files; pub mod files;
pub mod hg_path; pub mod hg_path;
pub mod path_auditor; pub mod path_auditor;
/// Useful until rust/issues/56345 is stable /// Useful until rust/issues/56345 is stable
/// ///
/// # Examples /// # Examples
/// ///
fn drop_prefix(&self, needle: &Self) -> Option<&Self> { fn drop_prefix(&self, needle: &Self) -> Option<&Self> {
if self.starts_with(needle) { if self.starts_with(needle) {
Some(&self[needle.len()..]) Some(&self[needle.len()..])
} else { } else {
None None
} }
} }
} }
pub trait Escaped {
/// Return bytes escaped for display to the user
fn escaped_bytes(&self) -> Vec<u8>;
}
impl Escaped for u8 {
fn escaped_bytes(&self) -> Vec<u8> {
let mut acc = vec![];
match self {
c @ b'\'' | c @ b'\\' => {
acc.push(b'\\');
acc.push(*c);
}
b'\t' => {
acc.extend(br"\\t");
}
b'\n' => {
acc.extend(br"\\n");
}
b'\r' => {
acc.extend(br"\\r");
}
c if (*c < b' ' || *c >= 127) => {
write!(acc, "\\x{:x}", self).unwrap();
}
c => {
acc.push(*c);
}
kevincoxUnsubmitted
Not Done
write!(acc, "\\x{:x}", self).unwrap();
kevincox: ``` write!(acc, "\\x{:x}", self).unwrap(); ```
AlphareAuthorUnsubmitted
Done

Oh nice!

Alphare: Oh nice!
}
acc
}
}
impl<'a, T: Escaped> Escaped for &'a [T] {
fn escaped_bytes(&self) -> Vec<u8> {
self.iter().flat_map(|item| item.escaped_bytes()).collect()
}
}
martinvonzUnsubmitted
Not Done

i.e. self.iter().flat_map(|item| item.escaped_bytes()).collect()?

martinvonz: i.e. `self.iter().flat_map(|item| item.escaped_bytes()).collect()`?
AlphareAuthorUnsubmitted
Done

Sometimes I forget about flat_map. Thanks!

Alphare: Sometimes I forget about `flat_map`. Thanks!
impl<T: Escaped> Escaped for Vec<T> {
fn escaped_bytes(&self) -> Vec<u8> {
self.deref().escaped_bytes()
}
}
impl<'a> Escaped for &'a HgPath {
fn escaped_bytes(&self) -> Vec<u8> {
self.as_bytes().escaped_bytes()
}
}