Struct CFlag

pub struct CFlag { /* private fields */ }

Each CONV symbol may be:

• ascii from EBCDIC to ASCII

• ebcdic from ASCII to EBCDIC

• ibm from ASCII to alternate EBCDIC

• block pad newline-terminated records with spaces to cbs-size

• unblock replace trailing spaces in cbs-size records with newline

• lcase change upper case to lower case

• ucase change lower case to upper case

• sparse try to seek rather than write the output for NUL input blocks

• swab swap every pair of input bytes

• sync pad every input block with NULs to ibs-size; when used with block or unblock, pad with spaces rather than NULs

• excl fail if the output file already exists

• nocreat do not create the output file

• notrunc do not truncate the output file

• noerror continue after read errors

• fdatasync physically write output file data before finishing

• fsync likewise, but also write metadata

Implementations

impl CFlag

pub const ASCII: Self

Translate from EBCDIC to ASCII

pub const EBCDIC: Self

Translate from ASCII to EBCDIC

pub const IBM: Self

Translate from ASCII to IBM

pub const OLDASCII: Self

Translate from EBCDIC to old ASCII

pub const OLDEBCDIC: Self

Translate from ASCII to old EBCDIC

pub const OLDIBM: Self

Translate from ASCII to old IBM

pub const BLOCK: Self

“block” mode: Treats the input as a sequence of newline or end-of-file terminated variable length records independent of input and output block bound- aries. Any trailing newline character is discarded. Each input record is converted to a fixed length output record where the length is specified by the cbs operand. Input records shorter than the conversion record size are padded with spaces. Input records longer than the conversion record size are truncated. The number of truncated input records, if any, are reported to the standard error output at the completion of the copy.

pub const UNBLOCK: Self

Treats the input as a sequence of fixed length records independent of input and output block boundaries. The length of the input records is specified by the cbs operand. Any trailing space characters are discarded and a newline character is appended.

pub const LCASE: Self

Transform uppercase [A-Z] characters into lowercase [a-z] characters.

pub const UCASE: Self

Transform lowercase [a-z] characters into uppercase [A-Z] characters

pub const SYNC: Self

Pad every input block to the input buffer size. Spaces are used for pad bytes if a block oriented conversion value is specified, otherwise NUL bytes are used.

pub const OSYNC: Self

Pad the final output block to the full output block size. If the input file is not a multiple of the output block size after conversion, this conversion forces the final output block to be the same size as preceding blocks for use on devices that require regularly sized blocks to be written. This option is incompatible with use of the bs=n block size specification. sparse If one or more output blocks would consist solely of NUL bytes, try to seek the output file by the required space instead of filling them with NULs, resulting in a sparse file.

pub const NOERROR: Self

Do not stop processing on an input error. When an input error occurs, a diagnostic message followed by the current input and output block counts will be written to the standard error output in the same format as the standard completion message. If the sync conversion is also specified, any missing input data will be replaced with NUL bytes (or with spaces if a block oriented conversion value was speci- fied) and processed as a normal input buffer. If the sync conversion is not specified, the input block is omitted from the output. On input files which are not tapes or pipes, the file offset will be positioned past the block in which the error occurred using lseek(2).

pub const NOTRUNC: Self

Do not truncate the output file. This will preserve any blocks in the output file not explicitly written by dd. The notrunc value is not supported for tapes.

pub const SPARSE: Self

If one or more output blocks would consist solely of NUL bytes, try to seek the out- put file by the required space instead of filling them with NULs, resulting in a sparse file.

pub const SWAB: Self

Swap every pair of input bytes. If an input buffer has an odd number of bytes, the last byte will be ignored during swapping.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Self) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

pub const fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

impl CFlag

pub fn new(s: &str) -> Result<Self>

Trait Implementations

impl Binary for CFlag

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitAnd for CFlag

fn bitand(self, other: Self) -> Self

Returns the intersection between the two sets of flags.

type Output = CFlag

The resulting type after applying the & operator.

impl BitAndAssign for CFlag

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr for CFlag

fn bitor(self, other: CFlag) -> Self

Returns the union of the two sets of flags.

type Output = CFlag

The resulting type after applying the | operator.

impl BitOrAssign for CFlag

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor for CFlag

fn bitxor(self, other: Self) -> Self

Returns the left flags, but with all the right flags toggled.

type Output = CFlag

The resulting type after applying the ^ operator.

impl BitXorAssign for CFlag

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for CFlag

fn clone(&self) -> CFlag

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CFlag

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CFlag

fn default() -> CFlag

Returns the “default value” for a type.

impl Extend<CFlag> for CFlag

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<CFlag> for CFlag

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl Hash for CFlag

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for CFlag

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Not for CFlag

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = CFlag

The resulting type after applying the ! operator.

impl Octal for CFlag

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for CFlag

fn cmp(&self, other: &CFlag) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CFlag

fn eq(&self, other: &CFlag) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CFlag

fn partial_cmp(&self, other: &CFlag) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for CFlag

fn sub(self, other: Self) -> Self

Returns the set difference of the two sets of flags.

type Output = CFlag

The resulting type after applying the - operator.

impl SubAssign for CFlag

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for CFlag

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for CFlag

impl Eq for CFlag

impl StructuralPartialEq for CFlag