Skip to main content

Expected

Struct Expected 

Source
pub struct Expected(/* private fields */);
Expand description

The list the gate is enforcing right now.

A SIGHUP replaces it, so the handle is shared rather than copied: the socket wrapper is built once at bind time and has to see a reload without being rebuilt, since rebuilding it would mean rebinding the port.

Read once per receive batch rather than once per datagram, and written once per reload, so a plain RwLock around an Arc is all the sharing this needs.

The flag beside it answers “is there a list at all” without taking the lock, because an empty list is the shipped default and every release before v0.9.0 behaved that way. A gate that is off then costs a receive batch one atomic load rather than a read guard, an Arc clone and its drop.

Implementations§

Source§

impl Expected

Source

pub fn new(names: Names) -> Self

A handle starting on names.

Source

pub fn set(&self, names: Names)

Replaces the list, for every datagram received from now on.

The list is written first and the flag second, with a Release store against the Acquire load in Expected::any, so a reader that sees the flag set also sees the list the flag is about.

The order matters in one direction only. A reader that has already loaded the flag while it still said “empty” judges its batch against the list that was in force a moment earlier, which is what a reload means for every datagram that arrived just before it and is why the gate can be reloaded at all. Storing the flag first would allow the opposite: a reader seeing “there is a list” and then reading a list that is not yet the new one, which is a judgement made against a list no configuration ever asked for.

Source

pub fn any(&self) -> bool

Whether the list in force holds any name, without taking the lock.

Source

pub fn current(&self) -> Arc<Names>

The list in force.

Poisoning would mean a panic while swapping an Arc; the value itself is immutable, so there is nothing to observe half-written.

Trait Implementations§

Source§

impl Clone for Expected

Source§

fn clone(&self) -> Expected

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Expected

Source§

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

Formats the value using the given formatter. Read more

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.

§

impl<T> Instrument for T

§

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

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

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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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