Struct tether_agent::plugs::three_part_topic::ThreePartTopic

pub struct ThreePartTopic { /* private fields */ }

Implementations

impl ThreePartTopic

pub fn new_for_publish( role: Option<&str>, id: Option<&str>, plug_name: &str, agent: &TetherAgent ) -> ThreePartTopic

Publish topics fall back to the ID and/or role associated with the agent, if not explicitly provided

pub fn new_for_subscribe( plug_name: &str, role_part_override: Option<&str>, id_part_override: Option<&str>, plug_name_part_override: Option<&str> ) -> ThreePartTopic

Subscribe topics fall back to wildcard + for role and/or id if not explicitly provided. If plug_name_part is specified as Some(String) then the plug name part of the generated topic is changed but the plug name itself is left alone.

pub fn new(role: &str, id: &str, plug_name: &str) -> ThreePartTopic

pub fn topic(&self) -> &str

pub fn role(&self) -> &str

pub fn id(&self) -> &str

pub fn plug_name(&self) -> &str

pub fn set_role(&mut self, role: &str)

pub fn set_id(&mut self, id: &str)

pub fn set_plug_name(&mut self, plug_name: &str)

Trait Implementations

impl Debug for ThreePartTopic

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ThreePartTopic

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ThreePartTopic

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for ThreePartTopic

fn try_from(value: &str) -> Result<Self, Self::Error>

Try to convert a topic string into a valid Tether Three Part Topic

type Error = Error

The type returned in the event of a conversion error.