Struct vmod_priv

#[repr(C)]
pub struct vmod_priv {
    pub priv_: *mut c_void,
    pub len: c_long,
    pub methods: *const vmod_priv_methods,
}

Fields

priv_: *mut c_void

len: c_long

methods: *const vmod_priv_methods

Implementations

impl vmod_priv

pub unsafe fn put<T>( &mut self, obj: Box<T>, methods: &'static vmod_priv_methods, )

Set the object and methods for the vmod_priv, and the corresponding static methods.

SAFETY: The type of obj must match the type of the function pointers in methods.

pub unsafe extern "C" fn on_fini<T>( _ctx: *const vrt_ctx, priv_: *mut c_void, )

A Varnish callback function to free a vmod_priv object. Here we take the ownership and immediately drop the object of type T. Note that here we get *priv_ directly, not the *vmod_priv

SAFETY: priv_ must be a valid pointer to a T object or NULL.

pub unsafe extern "C" fn on_fini_per_vcl<T>( ctx: *const vrt_ctx, priv_: *mut c_void, )

A Varnish callback function to clean up the PerVclState object. Similar to on_fini, but also unregisters filters.

SAFETY: priv_ must be a valid pointer to a T object or NULL.

impl vmod_priv

pub unsafe fn take<T>(&mut self) -> Option<Box<T>>

Transfer ownership of the object to the caller, cleaning up the internal state.

SAFETY: priv_ must reference a valid T object pointer or NULL

pub unsafe fn take_per_vcl<T>(&mut self) -> Box<PerVclState<T>>

pub unsafe fn get_ref<T>(&self) -> Option<&T>

Use the object as a reference, without taking ownership.

SAFETY:

• priv_ must reference a valid T object pointer or NULL
• take() must not be called on the same vmod_priv object until the returned reference is dropped
• cleanup must not be done on the object until the returned reference is dropped
• assumes Box<T> is equivalent to &T when used as a readonly reference, i.e. a box is just a pointer

Trait Implementations

impl Clone for vmod_priv

fn clone(&self) -> vmod_priv

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for vmod_priv

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

Formats the value using the given formatter.

impl Default for vmod_priv

fn default() -> Self

Returns the “default value” for a type.

impl Copy for vmod_priv