pub struct Flags(/* private fields */);Expand description
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:
§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 acookie::OpenErrorCookie::set_flags()might return acookie::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§
Source§impl Flags
impl Flags
Sourcepub const DEBUG: Self
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.
Sourcepub const SYMLINK: Self
pub const SYMLINK: Self
If the file queried is a symlink, follow it
This is equivalent to the file CLI option --dereference.
Sourcepub const COMPRESS: Self
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.
Sourcepub const DEVICES: Self
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.
Sourcepub const MIME_TYPE: Self
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/blockdeviceSourcepub const CONTINUE: Self
pub const CONTINUE: Self
Return all matches, not just the first
This is equivalent to the file CLI option --keep-going.
Sourcepub const CHECK: Self
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.
Sourcepub const PRESERVE_ATIME: Self
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.
Sourcepub const RAW: Self
pub const RAW: Self
Don’t translate unprintable characters to a \\ooo octal representation
This is equivalent to the file CLI option --raw.
Sourcepub const ERROR: Self
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
Sourcepub const MIME_ENCODING: Self
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
binarySourcepub const MIME: Self
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=binarySourcepub const APPLE: Self
pub const APPLE: Self
Return the Apple creator and type
This is equivalent to the file CLI option --apple.
Sourcepub const EXTENSION: Self
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: ???Sourcepub const COMPRESS_TRANSP: Self
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.
Sourcepub const NO_CHECK_COMPRESS: Self
pub const NO_CHECK_COMPRESS: Self
Don’t look inside compressed files
This is equivalent to the file CLI option --exclude compress.
Sourcepub const NO_CHECK_TAR: Self
pub const NO_CHECK_TAR: Self
Don’t examine tar files
This is equivalent to the file CLI option --exclude tar.
Sourcepub const NO_CHECK_SOFT: Self
pub const NO_CHECK_SOFT: Self
Don’t consult magic files
This is equivalent to the file CLI option --exclude soft.
Sourcepub const NO_CHECK_APPTYPE: Self
pub const NO_CHECK_APPTYPE: Self
Check for EMX application type (only on EMX)
This is equivalent to the file CLI option --exclude apptype.
Sourcepub const NO_CHECK_ELF: Self
pub const NO_CHECK_ELF: Self
Don’t print ELF details
This is equivalent to the file CLI option --exclude elf.
Sourcepub const NO_CHECK_TEXT: Self
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.
Sourcepub const NO_CHECK_CDF: Self
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.
Sourcepub const NO_CHECK_CSV: Self
pub const NO_CHECK_CSV: Self
Don’t examine CSV files
This is equivalent to the file CLI option --exclude csv.
Sourcepub const NO_CHECK_TOKENS: Self
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.
Sourcepub const NO_CHECK_ENCODING: Self
pub const NO_CHECK_ENCODING: Self
Don’t check text encodings
This is equivalent to the file CLI option --exclude encoding.
Sourcepub const NO_CHECK_JSON: Self
pub const NO_CHECK_JSON: Self
Don’t examine JSON files
This is equivalent to the file CLI option --exclude json.
Sourcepub const NO_COMPRESS_FORK: Self
Available on crate feature libmagic+v5-44 only.
pub const NO_COMPRESS_FORK: Self
libmagic+v5-44 only.Don’t allow decompressors that use fork
The enabled-by-default sandboxing of the file CLI implicitly activates this flag if available.
Sourcepub const NO_CHECK_SIMH: Self
Available on crate feature libmagic+v5-45 only.
pub const NO_CHECK_SIMH: Self
libmagic+v5-45 only.Don’t examine SIMH tape files
This is equivalent to the file CLI option --exclude simh.
Sourcepub const NO_CHECK_BUILTIN: Self
pub const NO_CHECK_BUILTIN: Self
No built-in tests; only consult the magic file
Source§impl Flags
impl Flags
Sourcepub const fn bits(&self) -> c_int
pub const fn bits(&self) -> c_int
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
Sourcepub const fn from_bits(bits: c_int) -> Option<Self>
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.
Sourcepub const fn from_bits_truncate(bits: c_int) -> Self
pub const fn from_bits_truncate(bits: c_int) -> Self
Convert from a bits value, unsetting any unknown bits.
Sourcepub const fn from_bits_retain(bits: c_int) -> Self
pub const fn from_bits_retain(bits: c_int) -> Self
Convert from a bits value exactly.
Sourcepub fn from_name(name: &str) -> Option<Self>
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.
Sourcepub const fn intersects(&self, other: Self) -> bool
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.
Sourcepub const fn contains(&self, other: Self) -> bool
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.
Sourcepub fn remove(&mut self, other: Self)
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.
Sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.
Sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert when value is true or remove when value is false.
Sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.
Sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|) of the bits in two flags values.
Sourcepub const fn difference(self, other: Self) -> Self
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.
Sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.
Sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.
Trait Implementations§
Source§impl BitAndAssign for Flags
impl BitAndAssign for Flags
Source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.
Source§impl BitOrAssign for Flags
impl BitOrAssign for Flags
Source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.
Source§impl BitXorAssign for Flags
impl BitXorAssign for Flags
Source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.
impl Copy for Flags
impl Eq for Flags
Source§impl Extend<Flags> for Flags
impl Extend<Flags> for Flags
Source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.
Source§fn extend_one(&mut self, item: T)
fn extend_one(&mut self, item: T)
extend_one)Source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one)Source§impl Flags for Flags
impl Flags for Flags
Source§fn from_bits_retain(bits: c_int) -> Flags
fn from_bits_retain(bits: c_int) -> Flags
Source§fn known_bits(&self) -> Self::Bits
fn known_bits(&self) -> Self::Bits
Source§fn unknown_bits(&self) -> Self::Bits
fn unknown_bits(&self) -> Self::Bits
Source§fn contains_unknown_bits(&self) -> bool
fn contains_unknown_bits(&self) -> bool
true if any unknown bits are set.Source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
Source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
Source§fn iter_names(&self) -> IterNames<Self> ⓘ
fn iter_names(&self) -> IterNames<Self> ⓘ
Source§fn iter_defined_names() -> IterDefinedNames<Self> ⓘ
fn iter_defined_names() -> IterDefinedNames<Self> ⓘ
Self::FLAGS.Source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
Source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
Source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|) of the bits in two flags values.Source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!). Read moreSource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^) of the bits in two flags values.Source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&) of the bits in two flags values.Source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!). Read moreSource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^) of the bits in two flags values.Source§fn complement(self) -> Self
fn complement(self) -> Self
!) of the bits in a flags value, truncating the result.Source§impl FromIterator<Flags> for Flags
impl FromIterator<Flags> for Flags
Source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|) of the bits in each flags value.
Source§impl IntoIterator for Flags
impl IntoIterator for Flags
Source§impl Ord for Flags
impl Ord for Flags
1.21.0 (const: unstable) · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
1.21.0 (const: unstable) · Source§fn min(self, other: Self) -> Selfwhere
Self: Sized,
fn min(self, other: Self) -> Selfwhere
Self: Sized,
Source§impl PartialOrd for Flags
impl PartialOrd for Flags
impl StructuralPartialEq for Flags
Source§impl Sub for Flags
impl Sub for Flags
Source§impl SubAssign for Flags
impl SubAssign for Flags
Source§fn sub_assign(&mut self, other: Self)
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.