Struct async_zeroconf::ServiceBrowserBuilder

pub struct ServiceBrowserBuilder { /* fields omitted */ }

ServiceBrowserBuilder is used to browse for services. Once all the required information is added to the ServiceBrowserBuilder the browse method will produce a ServiceBrowser which can be used as a stream, or the ServiceBrowser::recv method will produce the next service found.

Note

This does not resolve the services so does not contain all information associated with the service. A further resolve operation is required to fully populate the service. This can be done with a ServiceResolver. Alternatively, the ServiceBrowser::recv_resolve method can be used to resolve the services inline, or ServiceBrowser::resolving used to convert the stream into one that resolves services before returning them.

Examples

let mut browser = async_zeroconf::ServiceBrowserBuilder::new("_http._tcp");
let mut services = browser
    .timeout(tokio::time::Duration::from_secs(2))
    .browse()?;

while let Some(v) = services.recv().await {
    println!("Service = {:?}", v);
}

Implementations

impl ServiceBrowserBuilder

pub fn new(service_type: &str) -> Self

Create a new ServiceBrowserBuilder for the specified service type

pub fn timeout(&mut self, timeout: Duration) -> &mut Self

Set the timeout

pub fn close_on_end(&mut self) -> &mut Self

Set the browser to close if no more Services are found.

Note

The browser can only detect the end of the Services if any are found. A timeout can be used in combination with closing on end to ensure that the browser will terminate.

pub fn interface(&mut self, interface: Interface) -> &mut Self

Set the interface for service discovery rather than all

pub fn domain(&mut self, domain: String) -> &mut Self

Set the domain for service discovery rather than all

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

Start the browsing operation, which will continue until the specified timeout or until the ServiceBrowser is dropped.

Examples

let mut browser = async_zeroconf::ServiceBrowserBuilder::new("_http._tcp");
let mut services = browser
    .timeout(tokio::time::Duration::from_secs(2))
    .browse()?;

while let Some(Ok(v)) = services.recv().await {
    println!("Service = {:?}", v);
}

pub fn browse_task(
    &self
) -> Result<(ServiceBrowser, impl ProcessTask), ZeroconfError>

Start the browsing operation, which will continue until the specified timeout or until the ServiceBrowser is dropped. The returned ProcessTask future must be awaited to process events associated with the browser.

Note

This method is intended if more control is needed over how the task is spawned. ServiceBrowserBuilder::browse will automatically spawn the task.

Examples

let mut browser = async_zeroconf::ServiceBrowserBuilder::new("_http._tcp");
let (mut services, task) = browser
    .timeout(tokio::time::Duration::from_secs(2))
    .browse_task()?;

tokio::spawn(task);

while let Some(Ok(v)) = services.recv().await {
    println!("Service = {:?}", v);
}

Trait Implementations

impl Clone for ServiceBrowserBuilder

fn clone(&self) -> ServiceBrowserBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceBrowserBuilder

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

Formats the value using the given formatter.

impl Hash for ServiceBrowserBuilder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<ServiceBrowserBuilder> for ServiceBrowserBuilder

fn eq(&self, other: &ServiceBrowserBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ServiceBrowserBuilder) -> bool

This method tests for !=.

impl Eq for ServiceBrowserBuilder

impl StructuralEq for ServiceBrowserBuilder

impl StructuralPartialEq for ServiceBrowserBuilder