Struct Filter

pub struct Filter { /* private fields */ }

Implementations

impl Filter

pub const NORMAL: Filter

A normal file.

pub const META: Filter

A meta file (typically used by the CHM system).

pub const SPECIAL: Filter

A special file (starts with # or $).

pub const FILES: Filter

It’s a file.

pub const DIRS: Filter

It’s a directory.

pub const fn empty() -> Filter

Returns an empty set of flags

pub const fn all() -> Filter

Returns the set containing all flags.

Examples found in repository

examples/extract.rs (line 21)

fn main() {
    let args: Vec<_> = env::args().skip(1).collect();
    if args.len() != 2 || args.iter().any(|arg| arg.contains("-h")) {
        println!("Usage: extract <chm-file> <out-dir>");
        return;
    }

    let mut file = ChmFile::open(&args[0]).expect("Unable to open the file");

    let out_dir = PathBuf::from(&args[1]);

    file.for_each(Filter::all(), |file, item| extract(&out_dir, file, &item))
        .unwrap();
}

examples/enumerate-items.rs (line 16)

fn main() {
    let filename = env::args()
        .nth(1)
        .unwrap_or_else(|| panic!("Usage: enumerate-items <filename>"));

    let mut file = ChmFile::open(&filename).expect("Unable to open the file");

    println!("{}:", filename);
    println!(" spc    start   length   type\t\t\tname");
    println!(" ===    =====   ======   ====\t\t\t====");

    file.for_each(Filter::all(), |_file, item| {
        describe_item(item);
        Continuation::Continue
    })
    .unwrap();
}

pub const fn bits(&self) -> c_int

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: c_int) -> Option<Filter>

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

pub const fn from_bits_truncate(bits: c_int) -> Filter

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

pub const unsafe fn from_bits_unchecked(bits: c_int) -> Filter

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

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: Filter) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for Filter

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

Formats the value using the given formatter.

impl BitAnd for Filter

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

Returns the intersection between the two sets of flags.

type Output = Filter

The resulting type after applying the & operator.

impl BitAndAssign for Filter

fn bitand_assign(&mut self, other: Filter)

Disables all flags disabled in the set.

impl BitOr for Filter

fn bitor(self, other: Filter) -> Filter

Returns the union of the two sets of flags.

type Output = Filter

The resulting type after applying the | operator.

impl BitOrAssign for Filter

fn bitor_assign(&mut self, other: Filter)

Adds the set of flags.

impl BitXor for Filter

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

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

type Output = Filter

The resulting type after applying the ^ operator.

impl BitXorAssign for Filter

fn bitxor_assign(&mut self, other: Filter)

Toggles the set of flags.

impl Clone for Filter

fn clone(&self) -> Filter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

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

Formats the value using the given formatter.

impl Extend<Filter> for Filter

fn extend<T: IntoIterator<Item = Filter>>(&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<Filter> for Filter

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

Creates a value from an iterator.

impl Hash for Filter

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 Filter

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

Formats the value using the given formatter.

impl Not for Filter

fn not(self) -> Filter

Returns the complement of this set of flags.

type Output = Filter

The resulting type after applying the ! operator.

impl Octal for Filter

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

Formats the value using the given formatter.

impl Ord for Filter

fn cmp(&self, other: &Filter) -> 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 Filter

fn eq(&self, other: &Filter) -> 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 Filter

fn partial_cmp(&self, other: &Filter) -> 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 Filter

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

Returns the set difference of the two sets of flags.

type Output = Filter

The resulting type after applying the - operator.

impl SubAssign for Filter

fn sub_assign(&mut self, other: Filter)

Disables all flags enabled in the set.

impl UpperHex for Filter

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

Formats the value using the given formatter.

impl Copy for Filter

impl Eq for Filter

impl StructuralPartialEq for Filter