FieldDescriptor

Struct FieldDescriptor 

Source
pub struct FieldDescriptor {
    pub name: &'static str,
    pub kind: DataKind,
    pub nullable: bool,
    pub description: Option<&'static str>,
}
Expand description

Engine-agnostic field definition.

This replaces arrow::datatypes::Field in the Protocol trait, allowing protocol parsers to be used with any SQL backend.

Fields§

§name: &'static str

Field name (snake_case, e.g., “src_port”)

§kind: DataKind

Data type

§nullable: bool

Whether the field can be NULL

§description: Option<&'static str>

Optional description for documentation

Implementations§

Source§

impl FieldDescriptor

Source

pub const fn new(name: &'static str, kind: DataKind) -> Self

Create a new non-nullable field.

Source

pub const fn nullable(name: &'static str, kind: DataKind) -> Self

Create a new nullable field.

Source

pub const fn with_description(self, desc: &'static str) -> Self

Add a description to the field.

Source

pub const fn set_nullable(self, nullable: bool) -> Self

Builder: set nullability.

Source§

impl FieldDescriptor

Helper macros for common field patterns.

Source

pub const fn frame_number() -> Self

Frame number field (present in all protocol tables).

Source

pub const fn timestamp() -> Self

Timestamp field.

Source

pub const fn src_port() -> Self

Source port field.

Source

pub const fn dst_port() -> Self

Destination port field.

Source

pub const fn ipv4_field(name: &'static str) -> Self

IPv4 address field (stored as UInt32).

Source

pub const fn ipv6_field(name: &'static str) -> Self

IPv6 address field (stored as 16-byte binary).

Source

pub const fn mac_field(name: &'static str) -> Self

MAC address field (stored as 6-byte binary).

Trait Implementations§

Source§

impl Clone for FieldDescriptor

Source§

fn clone(&self) -> FieldDescriptor

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FieldDescriptor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for FieldDescriptor

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for FieldDescriptor

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more