Struct Abstract 

pub struct Abstract(/* private fields */);

The abstract netidx value type

Any type implementing Any + Pack + Send + Sync can be wrapped in an Abstract and published to netidx.

When a client reads an abstract value from netidx, it will look to see if it has the same type registered (by UUID). If it does, it will be able to decode the abstract type and use it. If it does not, then a special type called UnknownAbstractType will be substituted and the decode will not fail.

You may recover the original type by downcasting, which will fail if the type isn’t the one you expected.

Through abstract types the Value type can be extended in whatever way is suited by the application/user site without every netidx user needing to agree on a new protocol extension. As long as all the applications using an abstract type register it with the same UUID, and the Pack implementation remains compatible, then it can be seamlessly used without interfering with non participarting applications.

Implementations

impl Abstract

pub fn id(&self) -> Uuid

Look up the UUID of the concrete type of this Abstract

pub fn downcast_ref<T: Any + Send + Sync>(&self) -> Option<&T>

Downcast &self to &T. If self isn’t a T then return None.

pub fn register<T: Any + Debug + Pack + Hash + Eq + Ord + Send + Sync>( id: Uuid, ) -> Result<AbstractWrapper<T>>

Register a new abstract type, return an object that will wrap instances of T as an Abstract.

Register is idempotent.

• it is an error to register T with multiple different ids
• it is an error to register the same id with multiple Ts

Trait Implementations

impl Clone for Abstract

fn clone(&self) -> Abstract

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Abstract

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

Formats the value using the given formatter.

impl Default for Abstract

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Abstract

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Abstract

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Abstract

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl Pack for Abstract

fn encoded_len(&self) -> usize

fn encode(&self, buf: &mut impl BufMut) -> Result<(), PackError>

fn decode(buf: &mut impl Buf) -> Result<Self, PackError>

fn const_encoded_len() -> Option<usize>

fn decode_into(&mut self, buf: &mut impl Buf) -> Result<(), PackError>

where Self: Sized,

impl PartialEq for Abstract

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Abstract

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Abstract

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Abstract