Struct filemagic::flags::Flags

pub struct Flags { /* fields omitted */ }

Bitmask flags that specify how Cookie functions should behave

NOTE: The descriptions are taken from man libmagic 3.

Implementations

impl Flags

pub const NONE: Flags

No special handling

pub const DEBUG: Flags

Print debugging messages to stderr

NOTE: Those messages are printed by libmagic itself, no this Rust crate.

pub const SYMLINK: Flags

If the file queried is a symlink, follow it

pub const COMPRESS: Flags

If the file is compressed, unpack it and look at the contents

pub const DEVICES: Flags

If the file is a block or character special device, then open the device and try to look in its contents

pub const MIME_TYPE: Flags

Return a MIME type string, instead of a textual description

pub const CONTINUE: Flags

Return all matches, not just the first

pub const CHECK: Flags

Check the magic database for consistency and print warnings to stderr

NOTE: Those warnings are printed by libmagic itself, no this Rust crate.

pub const PRESERVE_ATIME: Flags

On systems that support utime(2) or utimes(2), attempt to preserve the access time of files analyzed

pub const RAW: Flags

Don't translate unprintable characters to a \ooo octal representation

pub const ERROR: Flags

Treat operating system errors while trying to open files and follow symlinks as real errors, instead of printing them in the magic buffer

pub const MIME_ENCODING: Flags

Return a MIME encoding, instead of a textual description

pub const MIME: Flags

A shorthand for MIME_TYPE | MIME_ENCODING

pub const APPLE: Flags

Return the Apple creator and type

pub const EXTENSION: Flags

Return a slash-separated list of extensions

pub const COMPRESS_TRANSP: Flags

Check inside compressed files but do not report compression

pub const NO_CHECK_COMPRESS: Flags

Don't look inside compressed files

pub const NO_CHECK_TAR: Flags

Don't examine tar files

pub const NO_CHECK_SOFT: Flags

Don't consult magic files

pub const NO_CHECK_APPTYPE: Flags

Check for EMX application type (only on EMX)

pub const NO_CHECK_ELF: Flags

Don't print ELF details

pub const NO_CHECK_TEXT: Flags

Don't check for various types of text files

pub const NO_CHECK_CDF: Flags

Don't get extra information on MS Composite Document Files

pub const NO_CHECK_TOKENS: Flags

Don't look for known tokens inside ascii files

pub const NO_CHECK_ENCODING: Flags

Don't check text encodings

pub const NO_CHECK_BUILTIN: Flags

No built-in tests; only consult the magic file

pub const NO_CHECK_ASCII: Flags

Don't look inside ascii files

pub const NO_CHECK_FORTRAN: Flags

Don't check ascii/fortran

pub const NO_CHECK_TROFF: Flags

Don't check ascii/troff

pub const fn empty() -> Flags

Returns an empty set of flags

pub const fn all() -> Flags

Returns the set containing all flags.

pub const fn bits(&self) -> c_int

Returns the raw value of the flags currently stored.

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

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) -> Flags

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for Flags

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

Formats the value using the given formatter.

impl BitAnd<Flags> for Flags

type Output = Flags

The resulting type after applying the & operator.

pub fn bitand(self, other: Flags) -> Flags

Returns the intersection between the two sets of flags.

impl BitAndAssign<Flags> for Flags

pub fn bitand_assign(&mut self, other: Flags)

Disables all flags disabled in the set.

impl BitOr<Flags> for Flags

type Output = Flags

The resulting type after applying the | operator.

pub fn bitor(self, other: Flags) -> Flags

Returns the union of the two sets of flags.

impl BitOrAssign<Flags> for Flags

pub fn bitor_assign(&mut self, other: Flags)

Adds the set of flags.

impl BitXor<Flags> for Flags

type Output = Flags

The resulting type after applying the ^ operator.

pub fn bitxor(self, other: Flags) -> Flags

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

impl BitXorAssign<Flags> for Flags

pub fn bitxor_assign(&mut self, other: Flags)

Toggles the set of flags.

impl Clone for Flags

pub fn clone(&self) -> Flags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Flags

impl Debug for Flags

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

Formats the value using the given formatter.

impl Default for Flags

pub fn default() -> Flags

Returns the "default value" for a type.

impl Eq for Flags

impl Extend<Flags> for Flags

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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<Flags> for Flags

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

Creates a value from an iterator.

impl Hash for Flags

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for Flags

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

Formats the value using the given formatter.

impl Not for Flags

type Output = Flags

The resulting type after applying the ! operator.

pub fn not(self) -> Flags

Returns the complement of this set of flags.

impl Octal for Flags

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

Formats the value using the given formatter.

impl Ord for Flags

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Flags> for Flags

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Flags> for Flags

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for Flags

impl StructuralPartialEq for Flags

impl Sub<Flags> for Flags

type Output = Flags

The resulting type after applying the - operator.

pub fn sub(self, other: Flags) -> Flags

Returns the set difference of the two sets of flags.

impl SubAssign<Flags> for Flags

pub fn sub_assign(&mut self, other: Flags)

Disables all flags enabled in the set.

impl UpperHex for Flags

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

Formats the value using the given formatter.