Struct win_etw_metadata::OutFlag

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

Specifies how a field should be interpreted or displayed.

Implementations

impl OutFlag

pub const NULL: OutFlag

No display at all.

pub const NOPRINT: OutFlag

No display at all.

pub const STRING: OutFlag

Contains text.

pub const BOOLEAN: OutFlag

Is a boolean. This can only be used with InFlag::INT8.

pub const HEX: OutFlag

Display in hexadecimal. Can be used with any integer type.

pub const PID: OutFlag

The field is a Win32 process ID.

pub const TID: OutFlag

The field is a Win32 thread ID.

pub const PORT: OutFlag

The field is a TCP/IP or UDP/IP port, in big-endian encoding.

pub const IPV4: OutFlag

The field is an IP v4 address, in big-endian encoding.

pub const IPV6: OutFlag

The field is an IP v6 address, in big-endian encoding.

pub const SOCKETADDRESS: OutFlag

The field is a SOCKADDR. See [SOCKADDR](https://docs.microsoft.com/en-us/windows/win32/api/winsock/ns-winsock-sockaddr).

pub const XML: OutFlag

The field is text, and should be interpreted as XML.

pub const JSON: OutFlag

The field is text, and should be interpreted as JSON.

pub const WIN32ERROR: OutFlag

The field is a Win32 error code. The field type should be InFlag::UINT32.

pub const NTSTATUS: OutFlag

The field is an NTSTATUS error code. The field type should be InFlag::UINT32.

pub const HRESULT: OutFlag

The field is an HRESULT error code. The field type should be InFlag::INT32.

pub const FILETIME: OutFlag

The field is a Win32 FILETIME value.

pub const SIGNED: OutFlag

Display field as signed.

pub const UNSIGNED: OutFlag

Display field as unsigned.

pub const UTF8: OutFlag

For strings, indicates that the string encoding is UTF-8.

pub const PKCS7_WITH_TYPE_INFO: OutFlag

Used with InFlag::BINARY.

pub const DATETIME_UTC: OutFlag

Indicates that the timezone for a time value is UTC. This can be used with InFlag::FILETIME or InFlag::SYSTEMTIME.

pub const fn empty() -> OutFlag

Returns an empty set of flags

pub const fn all() -> OutFlag

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

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

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for OutFlag

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

Formats the value using the given formatter.

impl BitAnd<OutFlag> for OutFlag

type Output = OutFlag

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<OutFlag> for OutFlag

fn bitand_assign(&mut self, other: OutFlag)

Disables all flags disabled in the set.

impl BitOr<OutFlag> for OutFlag

type Output = OutFlag

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<OutFlag> for OutFlag

fn bitor_assign(&mut self, other: OutFlag)

Adds the set of flags.

impl BitXor<OutFlag> for OutFlag

type Output = OutFlag

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<OutFlag> for OutFlag

fn bitxor_assign(&mut self, other: OutFlag)

Toggles the set of flags.

impl Clone for OutFlag

fn clone(&self) -> OutFlag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for OutFlag

impl Debug for OutFlag

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

Formats the value using the given formatter.

impl Eq for OutFlag

impl Extend<OutFlag> for OutFlag

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

Extends a collection with the contents of an iterator.

impl FromIterator<OutFlag> for OutFlag

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

Creates a value from an iterator.

impl Hash for OutFlag

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 OutFlag

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

Formats the value using the given formatter.

impl Not for OutFlag

type Output = OutFlag

The resulting type after applying the ! operator.

fn not(self) -> OutFlag

Returns the complement of this set of flags.

impl Octal for OutFlag

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

Formats the value using the given formatter.

impl Ord for OutFlag

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

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

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

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

This method tests for !=.

impl PartialOrd<OutFlag> for OutFlag

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for OutFlag

impl StructuralPartialEq for OutFlag

impl Sub<OutFlag> for OutFlag

type Output = OutFlag

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<OutFlag> for OutFlag

fn sub_assign(&mut self, other: OutFlag)

Disables all flags enabled in the set.

impl UpperHex for OutFlag

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

Formats the value using the given formatter.