Struct CapabilityAd 

pub struct CapabilityAd { /* private fields */ }

On-the-wire advertisement built by CapabilityRegistry::local_advertise.

Implementations

impl CapabilityAd

pub fn new() -> Self

Construct an empty advertisement.

pub fn from_entries(entries: Vec<CapabilityAdEntry>) -> Self

Build an advertisement from pre-shaped entries.

pub fn entries(&self) -> &[CapabilityAdEntry]

Read-only view of the advertised entries.

pub fn encode(&self) -> Vec<u8>

Serialise the advertisement to a length-prefixed byte stream. The encoding is stable, ASCII-clean for capability names, and uses only the standard library.

Examples

use dynomite::cluster::capability::{CapabilityAd, CapabilityAdEntry};
let ad = CapabilityAd::from_entries(vec![
    CapabilityAdEntry::new("framing".into(), vec![vec![1, 0, 0, 0]]),
]);
let bytes = ad.encode();
let back = CapabilityAd::decode(&bytes).unwrap();
assert_eq!(back, ad);

pub fn decode(bytes: &[u8]) -> Result<Self, CapabilityCodecError>

Inverse of CapabilityAd::encode. Rejects malformed or truncated input with a typed error.

Trait Implementations

impl Clone for CapabilityAd

fn clone(&self) -> CapabilityAd

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CapabilityAd

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

Formats the value using the given formatter.

impl Default for CapabilityAd

fn default() -> CapabilityAd

Returns the “default value” for a type.

impl PartialEq for CapabilityAd

fn eq(&self, other: &CapabilityAd) -> 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 Eq for CapabilityAd

impl StructuralPartialEq for CapabilityAd