Struct quilkin::config::Slot

pub struct Slot<T> { /* private fields */ }

A mutable memory location with atomic storage rules.

Implementations

impl<T> Slot<T>

pub fn new(value: impl Into<Option<T>>) -> Self

Creates a new slot for value.

pub fn empty() -> Self

Creates a new empty slot.

pub fn watch(&self, watcher: impl Fn(&T) + Send + Sync + 'static)

Adds a watcher to to the slot. The watcher will fire whenever slot’s value changes.

pub fn is_some(&self) -> bool

Returns whether any data is present in the slot.

impl<T: Default> Slot<T>

pub fn with_default() -> Self

Creates a new slot containing the default instance of T.

pub fn load(&self) -> Arc<T>

Provides a reference to the underlying data.

pub fn store(&self, value: Arc<T>)

Replaces the data in the slot with value.

pub fn remove(&self)

Removes any data from the slot.

impl<T: Default + PartialEq> Slot<T>

pub fn try_replace(&self, value: Self)

Replaces the current data in the slot with value’s data, if present.

impl<T: Clone + Default> Slot<T>

pub fn modify(&self, modify: impl FnMut(&mut T))

Provides a view into a mutable reference of the current data in the slot. Any changes made will update the value in the slot.

Trait Implementations

impl<T: Clone> Clone for Slot<T>

fn clone(&self) -> Slot<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Slot<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Slot<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for Slot<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Filter + Default> Filter for Slot<T>

fn read(&self, ctx: &mut ReadContext) -> Option<()>

Filter::read is invoked when the proxy receives data from a downstream connection on the listening port.

fn write(&self, ctx: &mut WriteContext) -> Option<()>

Filter::write is invoked when the proxy is about to send data to a downstream connection via the listening port after receiving it via one of the upstream Endpoints.

impl<T> From<Option<T>> for Slot<T>

fn from(data: Option<T>) -> Self

Converts to this type from the input type.

impl<T> From<T> for Slot<T>

fn from(data: T) -> Self

Converts to this type from the input type.

impl<T: JsonSchema + Default> JsonSchema for Slot<T>

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<T: PartialEq> PartialEq<Slot<T>> for Slot<T>

fn eq(&self, rhs: &Self) -> bool

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

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

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

impl<T: Serialize> Serialize for Slot<T>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.