This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6635

rust-utils: add docstrings and doctests for utils.rs
ClosedPublic

Authored by Alphare on Jul 10 2019, 11:42 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG5672bb73f61e: rust-utils: add docstrings and doctests for utils.rs
rHG95113d70e6af: rust-utils: add docstrings and doctests for utils.rs

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.Jul 10 2019, 11:42 AM
Alphare added a commit: rHG95113d70e6af: rust-utils: add docstrings and doctests for utils.rs.Jul 17 2019, 10:25 AM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHG95113d70e6af: rust-utils: add docstrings and doctests for utils.rs (authored by Alphare). · Explain Why
This revision was automatically updated to reflect the committed changes.
ThomasKenny added a subscriber: ThomasKenny.Feb 21 2022, 2:53 PM

I have been looking for a platform online where they have services specifically for playing games and this one was an epic choice. I will really appreciate if you guys could help me out in understanding the work ethics of professional college essay writers by recommending some platforms. Will really be grateful to you guys!

Revision Contents
Changeset List

PathPackages
Mrust/hg-core/src/lib.rs (2 lines)
Mrust/hg-core/src/utils.rs (57 lines)

Diff 15929

rust/hg-core/src/lib.rs

pub mod testing; // unconditionally built, for use from integration tests pub mod testing; // unconditionally built, for use from integration tests
pub use dirstate::{ pub use dirstate::{
dirs_multiset::DirsMultiset, dirs_multiset::DirsMultiset,
parsers::{pack_dirstate, parse_dirstate}, parsers::{pack_dirstate, parse_dirstate},
CopyVec, CopyVecEntry, DirsIterable, DirstateEntry, DirstateParents, CopyVec, CopyVecEntry, DirsIterable, DirstateEntry, DirstateParents,
DirstateVec, DirstateVec,
}; };
mod filepatterns; mod filepatterns;
mod utils; pub mod utils;
pub use filepatterns::{ pub use filepatterns::{
build_single_regex, read_pattern_file, PatternSyntax, PatternTuple, build_single_regex, read_pattern_file, PatternSyntax, PatternTuple,
}; };
/// Mercurial revision numbers /// Mercurial revision numbers
/// ///
/// As noted in revlog.c, revision numbers are actually encoded in /// As noted in revlog.c, revision numbers are actually encoded in

rust/hg-core/src/utils.rs

pub mod files; pub mod files;
/// Replaces the `from` slice with the `to` slice inside the `buf` slice.
///
/// # Examples
///
/// ```
/// use crate::hg::utils::replace_slice;
/// let mut line = b"I hate writing tests!".to_vec();
/// replace_slice(&mut line, b"hate", b"love");
/// assert_eq!(
/// line,
/// b"I love writing tests!".to_vec()
///);
///
/// ```
pub fn replace_slice<T>(buf: &mut [T], from: &[T], to: &[T]) pub fn replace_slice<T>(buf: &mut [T], from: &[T], to: &[T])
where where
T: Clone + PartialEq, T: Clone + PartialEq,
{ {
if buf.len() < from.len() || from.len() != to.len() { assert_eq!(from.len(), to.len());
if buf.len() < from.len() {
return; return;
} }
for i in 0..=buf.len() - from.len() { for i in 0..=buf.len() - from.len() {
if buf[i..].starts_with(from) { if buf[i..].starts_with(from) {
buf[i..(i + from.len())].clone_from_slice(to); buf[i..(i + from.len())].clone_from_slice(to);
} }
} }
} }
pub trait SliceExt { pub trait SliceExt {
fn trim(&self) -> &Self;
fn trim_end(&self) -> &Self; fn trim_end(&self) -> &Self;
fn trim_start(&self) -> &Self;
fn trim(&self) -> &Self;
} }
fn is_not_whitespace(c: &u8) -> bool { fn is_not_whitespace(c: &u8) -> bool {
!(*c as char).is_whitespace() !(*c as char).is_whitespace()
} }
impl SliceExt for [u8] { impl SliceExt for [u8] {
fn trim(&self) -> &[u8] { fn trim_end(&self) -> &[u8] {
if let Some(first) = self.iter().position(is_not_whitespace) {
if let Some(last) = self.iter().rposition(is_not_whitespace) { if let Some(last) = self.iter().rposition(is_not_whitespace) {
&self[first..last + 1] &self[..last + 1]
} else {
unreachable!();
}
} else { } else {
&[] &[]
} }
} }
fn trim_end(&self) -> &[u8] { fn trim_start(&self) -> &[u8] {
if let Some(last) = self.iter().rposition(is_not_whitespace) { if let Some(first) = self.iter().position(is_not_whitespace) {
&self[..last + 1] &self[first..]
} else { } else {
&[] &[]
} }
} }
/// ```
/// use hg::utils::SliceExt;
/// assert_eq!(
/// b" to trim ".trim(),
/// b"to trim"
/// );
/// assert_eq!(
/// b"to trim ".trim(),
/// b"to trim"
/// );
/// assert_eq!(
/// b" to trim".trim(),
/// b"to trim"
/// );
/// ```
fn trim(&self) -> &[u8] {
self.trim_start().trim_end()
}
} }