Struct VisuClient 

pub struct VisuClient {
    pub uri: String,
    pub timeout_s: f64,
    pub identifier: Option<String>,
    pub model: ModelRouter,
    pub material: MaterialRouter,
    pub obj: ObjectRouter,
    pub anchor: AnchorRouter,
    pub meta: MetaRouter,
    pub live: LiveRouter,
    /* private fields */
}

The client router for the REST API root endpoints.

Fields

uri: String

The fully qualified API URI ({uri}/api/).

timeout_s: f64

The request timeout in seconds.

identifier: Option<String>

The client identifier marking the originating source of objects.

model: ModelRouter

The model sub-router.

material: MaterialRouter

The material sub-router.

obj: ObjectRouter

The object sub-router.

anchor: AnchorRouter

The anchor sub-router.

meta: MetaRouter

The meta sub-router.

live: LiveRouter

The live data sub-router (websocket).

Implementations

impl VisuClient

pub fn new( uri: &str, ignore_meta_check: bool, identifier: Option<String>, ) -> Result<Self>

Creates a new client router rooted at uri.

Unless ignore_meta_check is set, the server name and version are verified against the client.

pub fn with_timeout( uri: &str, ignore_meta_check: bool, identifier: Option<String>, timeout_s: f64, ) -> Result<Self>

Creates a new client router with an explicit request timeout.

Errors

Returns Error::Value if timeout_s is negative, non-finite or too large to be represented as a duration.

pub fn clear(&self) -> Result<()>

Clears all objects and models from the scene.

pub fn clear_source(&self) -> Result<()>

Clears all objects and materials originating from this client’s source.

Trait Implementations

impl Debug for VisuClient

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

Formats the value using the given formatter.