Struct LinkFormatWrite

pub struct LinkFormatWrite<'a, T: ?Sized> { /* private fields */ }

Helper for writing IETF-RFC6690 CoAP link-formats to anything implementing core::fmt::Write.

Example

use async_coap::prelude::*;
use async_coap::LinkFormatWrite;
use async_coap::LINK_ATTR_INTERFACE_DESCRIPTION;

// String implements core::fmt::Write
let mut buffer = String::new();

let mut write = LinkFormatWrite::new(&mut buffer);

write.link(uri_ref!("/sensor/light"))
    .attr_quoted(LINK_ATTR_INTERFACE_DESCRIPTION,"sensor")
    .finish()
    .expect("Error writing link");

assert_eq!(&buffer, r#"</sensor/light>;if="sensor""#);

Implementations

impl<'a, T: Write + ?Sized> LinkFormatWrite<'a, T>

pub fn new(write: &'a mut T) -> LinkFormatWrite<'a, T>

Creates a new instance of LinkFormatWriter for a given instance that implements core::fmt::Write.

pub fn set_add_newlines(&mut self, add_newlines: bool)

Sets whether newlines should be added or not between links, possibly improving human readability an the expense of a few extra bytes.

pub fn link<'b, U: AnyUriRef + ?Sized>( &'b mut self, link: &U, ) -> LinkAttributeWrite<'a, 'b, T>

Adds a link to the link format and returns LinkAttributeWrite.

The returned LinkAttributeWrite instance can then be used to associate attributes to the link.

pub fn finish(self) -> Result<(), Error>

Consumes this LinkFormatWrite instance, returning any error that might have occurred during writing.

Trait Implementations

impl<'a, T: Debug + ?Sized> Debug for LinkFormatWrite<'a, T>

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

Formats the value using the given formatter.