Struct magic::cookie::Flags

pub struct Flags(/* private fields */);

Configuration bits for Cookie

A bitflags instance is a combined set of individual flags. cookie::Flags are configuration bits for Cookie instances that specify how the cookie should behave.

cookie::Flags influence several functions, e.g. Cookie::file() but also Cookie::load().

Flags are initially set when a new cookie is created with Cookie::open() and can be overwritten lateron with Cookie::set_flags().

Flags of particular interest:

• ERROR
• MIME
• EXTENSION
• CONTINUE
• NO_CHECK_BUILTIN

Examples

// default flags
// `: Flags` type annotation is only needed for this example
// if you pass it to Cookie::open() etc., Rust will figure it out
let flags: magic::cookie::Flags = Default::default();

// custom flags combination
let flags = magic::cookie::Flags::COMPRESS | magic::cookie::Flags::DEVICES;

Errors

Some flags might not be supported on all platforms, i.e.

• Cookie::open() might return a cookie::OpenError
• Cookie::set_flags() might return a cookie::SetFlagsError

Misc

NOTE: The flag descriptions are mostly copied from man libmagic 3.

MAGIC_NONE is the default, meaning “No special handling” and has no constant.

let default_flags: magic::cookie::Flags = Default::default();
assert_eq!(default_flags, magic::cookie::Flags::empty());

Implementations

impl Flags

pub const DEBUG: Self = _

Print debugging messages to stderr

This is equivalent to the file CLI option --debug.

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

This is equivalent to the file CLI option --dereference.

pub const COMPRESS: Self = _

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

This is equivalent to the file CLI option --uncompress.

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

This is equivalent to the file CLI option --special-files.

pub const MIME_TYPE: Self = _

Return a MIME type string, instead of a textual description

See also: Flags::MIME

This is equivalent to the file CLI option --mime-type.

NOTE: libmagic uses non-standard MIME types for at least some built-in checks, e.g. inode/* (also see Flags::SYMLINK, Flags::DEVICES):

$ file --mime-type /proc/self/exe
/proc/self/exe: inode/symlink

$ file --mime-type /dev/sda
/dev/sda: inode/blockdevice

pub const CONTINUE: Self = _

Return all matches, not just the first

This is equivalent to the file CLI option --keep-going.

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

This is equivalent to the file CLI option --preserve-date.

pub const RAW: Self = _

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

This is equivalent to the file CLI option --raw.

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

See also: Flags::MIME

This is equivalent to the file CLI option --mime-encoding.

NOTE: libmagic uses non-standard MIME charset values, e.g. for binary files:

$ file --mime-encoding /proc/self/exe
binary

pub const MIME: Self = _

A shorthand for MIME_TYPE | MIME_ENCODING

See also: Flags::MIME_TYPE, Flags::MIME_ENCODING

This is equivalent to the file CLI option --mime.

NOTE: libmagic returns a parseable MIME type with a charset field:

$ file --mime /proc/self/exe
/proc/self/exe: inode/symlink; charset=binary

pub const APPLE: Self = _

Return the Apple creator and type

This is equivalent to the file CLI option --apple.

pub const EXTENSION: Self = _

Return a slash-separated list of extensions for this file type

This is equivalent to the file CLI option --extension.

NOTE: libmagic returns a list with one or more extensions without a leading “.” (dot):

$ file --extension example.jpg
example.jpg: jpeg/jpg/jpe/jfif

$ file --extension /proc/self/exe
/proc/self/exe: ???

pub const COMPRESS_TRANSP: Self = _

Don’t report on compression, only report about the uncompressed data

This is equivalent to the file CLI option --uncompress-noreport.

pub const NODESC: Self = _

A shorthand for EXTENSION | MIME | APPLE

pub const NO_CHECK_COMPRESS: Self = _

Don’t look inside compressed files

This is equivalent to the file CLI option --exclude compress.

pub const NO_CHECK_TAR: Self = _

Don’t examine tar files

This is equivalent to the file CLI option --exclude tar.

pub const NO_CHECK_SOFT: Self = _

Don’t consult magic files

This is equivalent to the file CLI option --exclude soft.

pub const NO_CHECK_APPTYPE: Self = _

Check for EMX application type (only on EMX)

This is equivalent to the file CLI option --exclude apptype.

pub const NO_CHECK_ELF: Self = _

Don’t print ELF details

This is equivalent to the file CLI option --exclude elf.

pub const NO_CHECK_TEXT: Self = _

Don’t check for various types of text files

This is equivalent to the file CLI option --exclude text.

pub const NO_CHECK_CDF: Self = _

Don’t get extra information on MS Composite Document Files

This is equivalent to the file CLI option --exclude cdf.

pub const NO_CHECK_CSV: Self = _

Don’t examine CSV files

This is equivalent to the file CLI option --exclude csv.

pub const NO_CHECK_TOKENS: Self = _

Don’t look for known tokens inside ascii files

This is equivalent to the file CLI option --exclude tokens.

pub const NO_CHECK_ENCODING: Self = _

Don’t check text encodings

This is equivalent to the file CLI option --exclude encoding.

pub const NO_CHECK_JSON: Self = _

Don’t examine JSON files

This is equivalent to the file CLI option --exclude json.

pub const NO_CHECK_BUILTIN: Self = _

No built-in tests; only consult the magic file

impl Flags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> c_int

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

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

Convert from a bits value.

This method will return None if any unknown bits are set.

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

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: c_int) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl Flags

pub const fn iter(&self) -> Iter<Flags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<Flags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for Flags

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

Formats the value using the given formatter.

impl BitAnd for Flags

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

The bitwise and (&) of the bits in two flags values.

type Output = Flags

The resulting type after applying the & operator.

impl BitAndAssign for Flags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for Flags

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

The bitwise or (|) of the bits in two flags values.

type Output = Flags

The resulting type after applying the | operator.

impl BitOrAssign for Flags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for Flags

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = Flags

The resulting type after applying the ^ operator.

impl BitXorAssign for Flags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for Flags

fn clone(&self) -> Flags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Flags

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

Formats the value using the given formatter.

impl Default for Flags

fn default() -> Flags

Returns the “default value” for a type.

impl Display for Flags

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

Formats the value using the given formatter.

impl Extend<Flags> for Flags

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

The bitwise or (|) of the bits in each flags value.

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

const FLAGS: &'static [Flag<Flags>] = _

The set of defined flags.

type Bits = i32

The underlying bits type.

fn bits(&self) -> c_int

Get the underlying bits value.

fn from_bits_retain(bits: c_int) -> Flags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<Flags> for Flags

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

The bitwise or (|) of the bits in each flags value.

impl Hash for Flags

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

type Item = Flags

The type of the elements being iterated over.

type IntoIter = Iter<Flags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for Flags

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

Formats the value using the given formatter.

impl Not for Flags

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = Flags

The resulting type after applying the ! operator.

impl Octal for Flags

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

Formats the value using the given formatter.

impl Ord for Flags

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

Restrict a value to a certain interval.

impl PartialEq for Flags

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

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

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

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

impl PartialOrd for Flags

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

type Primitive = i32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for Flags

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = Flags

The resulting type after applying the - operator.

impl SubAssign for Flags

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for Flags

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

Formats the value using the given formatter.

impl Copy for Flags

impl Eq for Flags

impl StructuralPartialEq for Flags