Struct magic::CookieFlags

pub struct CookieFlags { /* fields omitted */ }

Bitmask flags that specify how Cookie functions should behave

NOTE: The descriptions are taken from man libmagic 3.

Implementations

impl CookieFlags

pub const NONE: Self

No special handling

pub const DEBUG: Self

Print debugging messages to stderr

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

pub const SYMLINK: Self

If the file queried is a symlink, follow it

pub const COMPRESS: Self

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

pub const DEVICES: Self

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: Self

Return a MIME type string, instead of a textual description

pub const CONTINUE: Self

Return all matches, not just the first

pub const CHECK: Self

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: Self

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

pub const RAW: Self

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

pub const ERROR: Self

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: Self

Return a MIME encoding, instead of a textual description

pub const MIME: Self

A shorthand for MIME_TYPE | MIME_ENCODING

pub const APPLE: Self

Return the Apple creator and type

pub const NO_CHECK_COMPRESS: Self

Don’t look inside compressed files

pub const NO_CHECK_TAR: Self

Don’t examine tar files

pub const NO_CHECK_SOFT: Self

Don’t consult magic files

pub const NO_CHECK_APPTYPE: Self

Check for EMX application type (only on EMX)

pub const NO_CHECK_ELF: Self

Don’t print ELF details

pub const NO_CHECK_TEXT: Self

Don’t check for various types of text files

pub const NO_CHECK_CDF: Self

Don’t get extra information on MS Composite Document Files

pub const NO_CHECK_TOKENS: Self

Don’t look for known tokens inside ascii files

pub const NO_CHECK_ENCODING: Self

Don’t check text encodings

pub const NO_CHECK_BUILTIN: Self

No built-in tests; only consult the magic file

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

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: c_int) -> 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: c_int) -> Self

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

pub const unsafe fn from_bits_unchecked(bits: c_int) -> 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.

Trait Implementations

impl Binary for CookieFlags

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

Formats the value using the given formatter.

impl BitAnd<CookieFlags> for CookieFlags

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

Returns the intersection between the two sets of flags.

type Output = Self

The resulting type after applying the & operator.

impl BitAndAssign<CookieFlags> for CookieFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<CookieFlags> for CookieFlags

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

Returns the union of the two sets of flags.

type Output = Self

The resulting type after applying the | operator.

impl BitOrAssign<CookieFlags> for CookieFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<CookieFlags> for CookieFlags

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

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

type Output = Self

The resulting type after applying the ^ operator.

impl BitXorAssign<CookieFlags> for CookieFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for CookieFlags

fn clone(&self) -> CookieFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CookieFlags

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

Formats the value using the given formatter.

impl Default for CookieFlags

fn default() -> CookieFlags

Returns NONE

impl Extend<CookieFlags> for CookieFlags

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<CookieFlags> for CookieFlags

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

Creates a value from an iterator.

impl Hash for CookieFlags

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, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for CookieFlags

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

Formats the value using the given formatter.

impl Not for CookieFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = Self

The resulting type after applying the ! operator.

impl Octal for CookieFlags

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

Formats the value using the given formatter.

impl Ord for CookieFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<CookieFlags> for CookieFlags

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

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

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

This method tests for !=.

impl PartialOrd<CookieFlags> for CookieFlags

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

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

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

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

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

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

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

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

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

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

impl Sub<CookieFlags> for CookieFlags

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

Returns the set difference of the two sets of flags.

type Output = Self

The resulting type after applying the - operator.

impl SubAssign<CookieFlags> for CookieFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for CookieFlags

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

Formats the value using the given formatter.

impl Copy for CookieFlags

impl Eq for CookieFlags

impl StructuralEq for CookieFlags

impl StructuralPartialEq for CookieFlags