Struct FieldFormat 

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

Values for the format byte of a field definition.

The low 7 bits of the format byte contain the field’s format. In the case of the Struct encoding, the low 7 bits of the format byte contain the number of logical fields in the struct (which must not be 0).

The top bit of the field format byte is the ChainFlag. If set, it indicates that a field tag (uint16) is present after the format byte. If not set, the field tag is not present and is assumed to be 0.

Implementations

impl FieldFormat

pub const Default: FieldFormat

Use the default format of the encoding.

pub const UnsignedInt: FieldFormat

unsigned integer, event byte order. Use with Value8..Value64 encodings.

pub const SignedInt: FieldFormat

signed integer, event byte order. Use with Value8..Value64 encodings.

pub const HexInt: FieldFormat

hex integer, event byte order. Use with Value8..Value64 encodings.

pub const Errno: FieldFormat

errno, event byte order. Use with Value32 encoding.

pub const Pid: FieldFormat

process id, event byte order. Use with Value32 encoding.

pub const Time: FieldFormat

signed integer, event byte order, seconds since 1970. Use with Value32 or Value64 encodings.

pub const Boolean: FieldFormat

0 = false, 1 = true, event byte order. Use with Value8..Value32 encodings.

pub const Float: FieldFormat

floating point, event byte order. Use with Value32..Value64 encodings.

pub const HexBytes: FieldFormat

binary, decoded as hex dump of bytes. Use with any encoding.

pub const String8: FieldFormat

8-bit char string, unspecified character set (usually treated as ISO-8859-1 or CP-1252). Use with Value8 and Char8 encodings.

pub const StringUtf: FieldFormat

UTF string, event byte order, code unit size based on encoding. Use with Value16..Value32 and Char8..Char32 encodings.

pub const StringUtfBom: FieldFormat

UTF string, BOM used if present, otherwise behaves like string_utf. Use with Char8..Char32 encodings.

pub const StringXml: FieldFormat

XML string, otherwise behaves like string_utf_bom. Use with Char8..Char32 encodings.

pub const StringJson: FieldFormat

JSON string, otherwise behaves like string_utf_bom. Use with Char8..Char32 encodings.

pub const Uuid: FieldFormat

UUID, network byte order (RFC 4122 format). Use with Value128 encoding.

pub const Port: FieldFormat

IP port, network byte order (in_port_t layout). Use with Value16 encoding.

pub const IPAddress: FieldFormat

IP address, network byte order (in_addr/in6_addr layout). Use with Value32 or Value128 encoding.

pub const IPAddressObsolete: FieldFormat

Do not produce this format. Decode the same as IPAddress.

pub const IPv4: FieldFormat = Self::IPAddress

Deprecated alias for IPAddress.

pub const IPv6: FieldFormat = Self::IPAddressObsolete

Deprecated alias for IPAddressObsolete.

pub const ValueMask: u8 = 127u8

Mask for the type field.

pub const ChainFlag: u8 = 128u8

A field tag (uint16) follows the format byte.

pub const fn from_int(value: u8) -> FieldFormat

Returns a FieldFormat with the specified value.

pub const fn as_int(self) -> u8

Returns the numeric value corresponding to this FieldFormat value.

pub const fn without_flags(self) -> FieldFormat

Returns the encoding without any flags (format & ValueMask).

pub const fn has_chain_flag(self) -> bool

Returns true if ChainFlag is present (tag present in event).

Trait Implementations

impl Clone for FieldFormat

fn clone(&self) -> FieldFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldFormat

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

Formats the value using the given formatter.

impl Default for FieldFormat

fn default() -> FieldFormat

Returns the “default value” for a type.

impl Display for FieldFormat

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

Formats the value using the given formatter.

impl From<u8> for FieldFormat

fn from(val: u8) -> FieldFormat

Converts to this type from the input type.

impl Hash for FieldFormat

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Ord for FieldFormat

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

Restrict a value to a certain interval.

impl PartialEq for FieldFormat

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for FieldFormat

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for FieldFormat

impl Eq for FieldFormat

impl StructuralPartialEq for FieldFormat