Struct milter::Context

pub struct Context<T> {
    pub api: ContextApi,
    pub data: DataHandle<T>,
}

Context supplied to the milter callbacks.

The Context<T> struct provides access to the context API via its api field. It also provides access to connection-local user data, the type of which is T.

Safety

The type parameter T specifies the type of the value to be retrieved from the data handle. Retrieving the data is potentially an unsafe operation, as the data needs to be materialised from a raw C pointer. Take care not to introduce a mismatch when specifying T; T should always be the same type over the whole callback flow.

Fields

api: ContextApi

An accessor to the API methods operating on this context.

data: DataHandle<T>

A handle on user data associated with this context.

Methods

impl<T> Context<T>

pub fn new(ptr: *mut SMFICTX) -> Self

Constructs a new Context from the milter library-supplied raw context pointer.

You do not normally need to use new; a Context is already supplied to the callbacks.

Panics

Panics if ptr is null.

Trait Implementations

impl<T: Debug> Debug for Context<T>

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

Formats the value using the given formatter.