Struct TxtRecord

pub struct TxtRecord { /* private fields */ }

Struct containing the entries for TXT records associated with a service

Examples

let mut txt = async_zeroconf::TxtRecord::new();
txt.add("key1".to_string(), "value1".to_string());
txt.add("key2".to_string(), "value2".to_string());
let service_ref = async_zeroconf::Service::new_with_txt("Server", "_http._tcp", 80, txt)
                      .publish().await?;

Implementations

impl TxtRecord

pub fn new() -> Self

Create a new TXT record collection

pub fn add(&mut self, k: String, v: String)

Add an entry from a string

pub fn add_vec(&mut self, k: String, v: Vec<u8>)

Add an entry from a slice of u8’s

pub fn iter(&self) -> impl Iterator<Item = (&String, &Vec<u8>)>

Get Iterator

Examples

let mut txt = async_zeroconf::TxtRecord::new();
txt.add("key".to_string(), "value".to_string());
// Iterator
let iter = txt.iter();
for (k, v) in iter {
    println!("{}, {:?}", k, v);
}

pub fn iter_string( &self, ) -> impl Iterator<Item = (&String, Result<&str, Utf8Error>)>

Get Iterator including conversion to string. As the conversion to a UTF-8 string could fail the value is returned as a Result.

Examples

let mut txt = async_zeroconf::TxtRecord::new();
txt.add("key".to_string(), "value".to_string());
// String iterator
let iter = txt.iter_string();
for (k, v) in iter {
    match v {
        Ok(v) => println!("{}, {}", k, v),
        Err(_) => println!("{} not valid UTF-8", k)
    }
}

pub fn iter_string_lossy(&self) -> impl Iterator<Item = (&String, &str)>

Get Iterator including conversion to string. If the conversion to UTF-8 fails, ‘�’ will be returned instead.

Examples

let mut txt = async_zeroconf::TxtRecord::new();
txt.add("key".to_string(), "value".to_string());
// String iterator
let iter = txt.iter_string_lossy();
for (k, v) in iter {
    println!("{}, {}", k, v);
}

pub fn validate(&self) -> Result<(), ZeroconfError>

Validate if this TXT record collection contains all valid values. This checks that the key is 9 characters or less, the value is 255 characters or less and that the key only has printable ASCII characters excluding ‘=’.

Examples

let mut valid_txt = async_zeroconf::TxtRecord::new();
valid_txt.add("key".to_string(), "value".to_string());
assert!(valid_txt.validate().is_ok());

let mut invalid_txt = async_zeroconf::TxtRecord::new();
invalid_txt.add("k\0".to_string(), "value".to_string());
assert!(invalid_txt.validate().is_err());

pub fn is_empty(&self) -> bool

Empty if no records are associated

Trait Implementations

impl Clone for TxtRecord

fn clone(&self) -> TxtRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TxtRecord

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

Formats the value using the given formatter.

impl Default for TxtRecord

fn default() -> Self

Returns the “default value” for a type.

impl Display for TxtRecord

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

Formats the value using the given formatter.

impl PartialEq for TxtRecord

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

impl StructuralPartialEq for TxtRecord