Struct mem_dbg::DbgFlags

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

Flags for MemDbg.

Implementations

impl DbgFlags

pub const FOLLOW_REFS: Self = _

Follow references. See SizeFlags::FOLLOW_REFS.

pub const HUMANIZE: Self = _

Print memory usage in human readable format.

pub const PERCENTAGE: Self = _

Print memory usage as a percentage.

pub const TYPE_NAME: Self = _

Print the type name.

pub const CAPACITY: Self = _

Display capacity instead of size. See SizeFlags::CAPACITY.

pub const SEPARATOR: Self = _

Add an underscore every 3 digits.

pub const RUST_LAYOUT: Self = _

Print fields in memory order (i.e., using the layout chosen by the compiler), rather than in declaration order.

impl DbgFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

Examples found in repository

examples/readme.rs (line 55)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    use mem_dbg::*;

    #[derive(MemSize, MemDbg)]
    struct Struct<A, B> {
        a: A,
        b: B,
        test: isize,
    }

    #[derive(MemSize, MemDbg)]
    struct Data<A> {
        a: A,
        b: Vec<i32>,
        c: (u8, String),
    }

    #[derive(MemSize, MemDbg)]
    enum TestEnum {
        Unit,
        Unit2(),
        Unit3 {},
        Unnamed(usize, usize),
        Named { first: usize, second: u8 },
    }

    let b = Vec::with_capacity(100);

    let s = Struct {
        a: TestEnum::Unnamed(0, 16),
        b: Data {
            a: vec![0x42_u8; 700],
            b,
            c: (1, "foo".to_owned()),
        },
        test: -0xbadf00d,
    };

    println!("size:     {}", s.mem_size(SizeFlags::default()));
    println!("capacity: {}", s.mem_size(SizeFlags::CAPACITY));
    println!();

    s.mem_dbg(DbgFlags::empty())?;

    println!();

    println!("size:     {}", s.mem_size(SizeFlags::default()));
    println!("capacity: {}", s.mem_size(SizeFlags::CAPACITY));
    println!();

    s.mem_dbg(DbgFlags::default() | DbgFlags::CAPACITY | DbgFlags::HUMANIZE)?;

    #[cfg(feature = "offset_of_enum")]
    {
        println!();

        println!("size:     {}", s.mem_size(SizeFlags::default()));
        println!("capacity: {}", s.mem_size(SizeFlags::CAPACITY));
        println!();

        s.mem_dbg(DbgFlags::empty() | DbgFlags::RUST_LAYOUT)?;
    }
    Ok(())
}

examples/example.rs (line 109)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut b = Vec::with_capacity(100);
    b.extend(0..10);
    let mut h = HashSet::with_capacity(100);
    h.extend(0..10);

    let s = Struct {
        a: TestEnum::Unnamed(0, 16),
        b: Data {
            a: vec![0x42_u8; 700],
            b: b.clone(),
            c: (1, "foo".to_owned()),
        },
        test: -0xbadf00d,
        h: h.clone(),
    };

    // print the size in bytes of the value
    println!("size:     {}", s.mem_size(SizeFlags::default()));
    println!("capacity: {}", s.mem_size(SizeFlags::CAPACITY));

    println!();

    println!("DbgFlags::default():");
    println!();
    s.mem_dbg(DbgFlags::default())?;

    println!();

    println!("DbgFlags::default() | DbgFlags::CAPACITY:");
    println!();
    s.mem_dbg(DbgFlags::default() | DbgFlags::CAPACITY)?;

    println!();

    println!("DbgFlags::default() | DbgFlags::CAPACITY | DbgFlags::HUMANIZE:");
    println!();
    s.mem_dbg(DbgFlags::default() | DbgFlags::HUMANIZE)?;

    println!();

    println!("DbgFlags::default() | DbgFlags::CAPACITY | DbgFlags::HUMANIZE:");
    println!();
    s.mem_dbg(DbgFlags::default() | DbgFlags::CAPACITY | DbgFlags::HUMANIZE)?;

    println!();

    let s = Struct {
        a: TestEnum::Named {
            first: 0,
            second: 1,
        },
        b: Data {
            a: vec![0x42_u8; 700],
            b,
            c: (1, "foo".to_owned()),
        },
        test: -0xbadf00d,
        h,
    };

    println!("DbgFlags::empty():");
    println!();
    s.mem_dbg(DbgFlags::empty())?;

    #[cfg(feature = "offset_of_enum")]
    {
        println!();
        println!("DbgFlags::HUMANIZE | DbgFlags::RUST_LAYOUT:");
        println!();
        s.mem_dbg(DbgFlags::HUMANIZE | DbgFlags::RUST_LAYOUT)?;
    }
    let s = Struct {
        a: 0_u8,
        b: 0_u8,
        test: 1,
        h: HashSet::new(),
    };

    println!();

    println!("DbgFlags::empty()");
    println!();
    s.mem_dbg(DbgFlags::empty())?;

    println!();

    println!("DbgFlags::RUST_LAYOUT");
    println!();
    s.mem_dbg(DbgFlags::RUST_LAYOUT)?;

    Ok(())
}

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

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

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

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> 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 DbgFlags

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

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<DbgFlags>

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.

impl DbgFlags

pub fn to_size_flags(&self) -> SizeFlags

Translates flags that are in common with MemSize into SizeFlags.

Trait Implementations

impl Binary for DbgFlags

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

Formats the value using the given formatter.

impl BitAnd for DbgFlags

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

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

type Output = DbgFlags

The resulting type after applying the & operator.

impl BitAndAssign for DbgFlags

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for DbgFlags

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

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

type Output = DbgFlags

The resulting type after applying the | operator.

impl BitOrAssign for DbgFlags

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for DbgFlags

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

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

type Output = DbgFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for DbgFlags

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for DbgFlags

fn clone(&self) -> DbgFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DbgFlags

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

Formats the value using the given formatter.

impl Default for DbgFlags

fn default() -> Self

The default set of flags contains DbgFlags::TYPE_NAME, DbgFlags::SEPARATOR, and DbgFlags::PERCENTAGE.

impl Extend<DbgFlags> for DbgFlags

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 DbgFlags

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

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> DbgFlags

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

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

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

impl Hash for DbgFlags

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 DbgFlags

type Item = DbgFlags

The type of the elements being iterated over.

type IntoIter = Iter<DbgFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for DbgFlags

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

Formats the value using the given formatter.

impl Not for DbgFlags

fn not(self) -> Self

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

type Output = DbgFlags

The resulting type after applying the ! operator.

impl Octal for DbgFlags

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

Formats the value using the given formatter.

impl Ord for DbgFlags

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

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

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

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

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

impl Sub for DbgFlags

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 = DbgFlags

The resulting type after applying the - operator.

impl SubAssign for DbgFlags

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 DbgFlags

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

Formats the value using the given formatter.

impl Copy for DbgFlags

impl Eq for DbgFlags

impl StructuralPartialEq for DbgFlags