Mirrors/coreutils
2
0
Fork 0
mirror of https://github.com/uutils/coreutils synced 2025-01-20 17:14:21 +00:00
Code Issues Projects Releases Packages Wiki Activity

add: documentation to refactored macros->functions

Browse source
This commit is contained in:
snapdgn 2022-09-12 18:35:30 +05:30
parent 243546ce96
commit d8226bf658
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/uu/stat/src/stat.rs
View file

@ -26,6 +26,8 @@ use std::os::unix::prelude::OsStrExt;
use std::path::Path; use std::path::Path;
use std::{cmp, fs, iter}; use std::{cmp, fs, iter};
/// checks if the string is within the specified bound
///
fn check_bound(slice: &str, bound: usize, beg: usize, end: usize) -> UResult<()> { fn check_bound(slice: &str, bound: usize, beg: usize, end: usize) -> UResult<()> {
if end >= bound { if end >= bound {
return Err(USimpleError::new( return Err(USimpleError::new(
@ -36,6 +38,9 @@ fn check_bound(slice: &str, bound: usize, beg: usize, end: usize) -> UResult<()>
Ok(()) Ok(())
} }
/// pads the string with zeroes if supplied min is greater
/// then the length of the string, else returns the original string
///
fn extend_digits(string: &str, min: usize) -> Cow<'_, str> { fn extend_digits(string: &str, min: usize) -> Cow<'_, str> {
if min > string.len() { if min > string.len() {
let mut pad = String::with_capacity(min); let mut pad = String::with_capacity(min);
@ -55,6 +60,16 @@ enum Padding {
Space, Space,
} }
/// pads the string with zeroes or spaces and prints it
///
/// # Example
/// ```ignore
/// uu_stat::pad_and_print("1", false, 5, Padding::Zero) == "00001";
/// ```
/// currently only supports '0' & ' ' as the padding character
/// because the format specification of print! does not support general
/// fill characters
///
fn pad_and_print(result: &str, left: bool, width: usize, padding: Padding) { fn pad_and_print(result: &str, left: bool, width: usize, padding: Padding) {
match (left, padding) { match (left, padding) {
(false, Padding::Zero) => print!("{result:0>width$}"), (false, Padding::Zero) => print!("{result:0>width$}"),
@ -64,6 +79,8 @@ fn pad_and_print(result: &str, left: bool, width: usize, padding: Padding) {
}; };
} }
/// prints the adjusted string after padding
///
fn print_adjusted( fn print_adjusted(
s: &str, s: &str,
left: bool, left: bool,