Struct win_etw_metadata::InFlag

#[repr(transparent)]pub struct InFlag { /* fields omitted */ }

Defines the input type of a field. In traceloggingprovider.h, this is the 'TlgIn_t` enumerated type.

Implementations

impl InFlag

pub const NULL: InFlag

No value at all

pub const UNICODE_STRING: InFlag

A wide string (UTF-16), corresponding to PCWSTR in Win32.

pub const ANSI_STRING: InFlag

An ANSI string, corresponding to PCSTR in Win32. The character set can be specified as UTF-8 by using OutFlag::UTF8.

pub const INT8: InFlag

i8

pub const UINT8: InFlag

u8

pub const INT16: InFlag

i16, stored in little-endian form.

pub const UINT16: InFlag

u16, stored in little-endian form.

pub const INT32: InFlag

i16, stored in little-endian form.

pub const UINT32: InFlag

u32, stored in little-endian form.

pub const INT64: InFlag

i64, stored in little-endian form.

pub const UINT64: InFlag

u64, stored in little-endian form.

pub const FLOAT: InFlag

f32, stored in little-endian form.

pub const DOUBLE: InFlag

f64, stored in little-endian form.

pub const BOOL32: InFlag

A Win32 'BOOL' value, which is i32, stored in little-endian form.

pub const BINARY: InFlag

An array of bytes, stored in little-endian form.

pub const GUID: InFlag

A GUID, stored in canonical byte-oriented representation. The fields within the GUID are stored in big-endian form.

pub const FILETIME: InFlag

A Win32 FILETIME value. FILETIME values are u64 values, stored in little-endian form, counting 100ns intervals from the FILETIME epoch.

pub const SYSTEMTIME: InFlag

A Win32 SYSTEMTIME value, with fields encoded in little-endian form.

pub const SID: InFlag

A Win32 SID.

pub const HEXINT32: InFlag

An i32 value, encoded in little-endian form, displayed in hexadecimal.

pub const HEXINT64: InFlag

An i64 value, encoded in little-endian form, displayed in hexadecimal.

pub const COUNTED_UNICODE_STRING: InFlag

A counted wide string (UTF-16), corresponding to UNICODE_STRING in Win32. This type uses two data descriptor slots. The first is a u16 value, giving the length of the string data in WCHAR units (not bytes). The second points to the character data.

pub const COUNTED_ANSI_STRING: InFlag

A counted ANSI string, corresponding to STRING in Win32. The character set can be specified as UTF-8 by using OutFlag::UTF8. This type uses two data descriptor slots. The first is a u16 value, giving the length of the string data in WCHAR units (not bytes). The second points to the character data.

pub const CCOUNT_FLAG: InFlag

A flag which indicates that this field is an array of constant length. If this field is present, then the metadata contains an additional u16 field, which is the constant length.

pub const VCOUNT_FLAG: InFlag

A flag which indicates that this field has a dynamic length. The field uses two data descriptors. The first is a u16 field specifying the length of the array. The second points to the array data.

pub const CHAIN_FLAG: InFlag

A flag which indicates that this field metadata also includes an OutFlag. The OutFlag byte immediately follows the InFlag byte.

pub const CUSTOM_FLAG: InFlag

A flag which indicates that the field uses a custom serializer.

pub const TYPE_MASK: InFlag

A mask of the field type flags.

pub const COUNT_MASK: InFlag

A mask of the field length flags (VCOUNT_FLAG, CCOUNT_FLAG, CUSTOM_FLAG).

pub const FLAG_MASK: InFlag

A mask over all of the flags (all bits excluding the type bits).

pub const fn empty() -> InFlag

Returns an empty set of flags

pub const fn all() -> InFlag

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<InFlag>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u8) -> InFlag

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

pub const unsafe fn from_bits_unchecked(bits: u8) -> InFlag

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

impl InFlag

pub const USIZE: InFlag

An alias for the architecture-dependent USIZE (pointer-sized word) InFlag.

pub const ISIZE: InFlag

An alias for the architecture-dependent ISIZE (pointer-sized word) InFlag.

Trait Implementations

impl Binary for InFlag

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

Formats the value using the given formatter.

impl BitAnd<InFlag> for InFlag

type Output = InFlag

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<InFlag> for InFlag

fn bitand_assign(&mut self, other: InFlag)

Disables all flags disabled in the set.

impl BitOr<InFlag> for InFlag

type Output = InFlag

The resulting type after applying the | operator.

fn bitor(self, other: InFlag) -> InFlag

Returns the union of the two sets of flags.

impl BitOrAssign<InFlag> for InFlag

fn bitor_assign(&mut self, other: InFlag)

Adds the set of flags.

impl BitXor<InFlag> for InFlag

type Output = InFlag

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<InFlag> for InFlag

fn bitxor_assign(&mut self, other: InFlag)

Toggles the set of flags.

impl Clone for InFlag

fn clone(&self) -> InFlag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for InFlag

impl Debug for InFlag

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

Formats the value using the given formatter.

impl Eq for InFlag

impl Extend<InFlag> for InFlag

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

Extends a collection with the contents of an iterator.

impl FromIterator<InFlag> for InFlag

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

Creates a value from an iterator.

impl Hash for InFlag

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 InFlag

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

Formats the value using the given formatter.

impl Not for InFlag

type Output = InFlag

The resulting type after applying the ! operator.

fn not(self) -> InFlag

Returns the complement of this set of flags.

impl Octal for InFlag

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

Formats the value using the given formatter.

impl Ord for InFlag

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<InFlag> for InFlag

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

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

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

This method tests for !=.

impl PartialOrd<InFlag> for InFlag

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for InFlag

impl StructuralPartialEq for InFlag

impl Sub<InFlag> for InFlag

type Output = InFlag

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<InFlag> for InFlag

fn sub_assign(&mut self, other: InFlag)

Disables all flags enabled in the set.

impl UpperHex for InFlag

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

Formats the value using the given formatter.