Struct agde::Capabilities

pub struct Capabilities { /* private fields */ }

Describes the capabilities and properties of the client. Sent in the initial Message exchange.

Implementations

impl Capabilities

pub fn new(uuid: Uuid, persistent: bool, help_desire: i16) -> Self

Creates a new set of capabilities and properties used by this client.

See the various getters for more information about the usage of these options.

pub fn version(&self) -> &Version

Version of this client.

pub fn version_compatible(&self, other: &Capabilities) -> bool

Check is the versions are compatible.

pub fn uuid(&self) -> Uuid

The UUID of this client.

pub fn persistent(&self) -> bool

The client is striving to be persistent. These will regularly do MessageKind::HashCheck.

pub fn help_desire(&self) -> i16

The desire to communicate with others in the system.

This value will go from i16::MIN, which means “I want none o’ this” to i16::MAX which means the client is happy to help others. See Self::effective_help_desire for how this range is used. This will usually be set in accordance to the free processing power a client has to offer.

This will play part in deciding which client to send check requests to. Normally, the always-on clients (those started alongside the server, if there is any), will have a high value.

pub fn effective_help_desire(&self) -> f32

Returns a desire to help in a lower range.

This can be used to calculate the relative desire. For now, the whole i16 range is collapsed to [0..9) This uses a root function (⁵√self.help_desire). This leads to a help_desire of 1024 being just half as likely to be chosen as i16::MAX. A help_desire of 0 returns 1 from this function. The value returned from this function will never be 0 or less.

Trait Implementations

impl Clone for Capabilities

fn clone(&self) -> Capabilities

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Capabilities

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Capabilities

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Capabilities> for Capabilities

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

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 Capabilities

impl StructuralEq for Capabilities

impl StructuralPartialEq for Capabilities