Skip to main content

ServerMessage

Enum ServerMessage 

Source
pub enum ServerMessage {
    Load {
        request_id: Uuid,
        instance_id: InstanceId,
        graphic_id: String,
        data: Option<Value>,
    },
    PlayAction {
        request_id: Uuid,
        instance_id: InstanceId,
        goto: Option<f64>,
        delta: Option<f64>,
        skip_animation: Option<bool>,
    },
    StopAction {
        request_id: Uuid,
        instance_id: InstanceId,
        skip_animation: Option<bool>,
    },
    UpdateAction {
        request_id: Uuid,
        instance_id: InstanceId,
        data: Value,
        skip_animation: Option<bool>,
    },
    CustomAction {
        request_id: Uuid,
        instance_id: InstanceId,
        action_id: String,
        payload: Value,
        skip_animation: Option<bool>,
    },
    RendererCustomAction {
        request_id: Uuid,
        action_id: String,
        payload: Value,
        skip_animation: Option<bool>,
    },
    Clear {
        request_id: Uuid,
        instance_id: InstanceId,
    },
}
Expand description

Messages sent from the server to a renderer over its WebSocket. Every variant carries a request_id so the HTTP handler that triggered it can correlate the renderer’s eventual *Result reply (see RendererMessage) and return the real statusCode/statusMessage, per the OGraf spec.

Variants§

§

Load

Fields

§request_id: Uuid
§instance_id: InstanceId
§graphic_id: String
§

PlayAction

Fields

§request_id: Uuid
§instance_id: InstanceId
§goto: Option<f64>
§delta: Option<f64>
§skip_animation: Option<bool>
§

StopAction

Fields

§request_id: Uuid
§instance_id: InstanceId
§skip_animation: Option<bool>
§

UpdateAction

Fields

§request_id: Uuid
§instance_id: InstanceId
§data: Value
§skip_animation: Option<bool>
§

CustomAction

Fields

§request_id: Uuid
§instance_id: InstanceId
§action_id: String
§payload: Value
§skip_animation: Option<bool>
§

RendererCustomAction

A custom action invoked on the Renderer itself, not on a GraphicInstance.

Fields

§request_id: Uuid
§action_id: String
§payload: Value
§skip_animation: Option<bool>
§

Clear

Fields

§request_id: Uuid
§instance_id: InstanceId

Implementations§

Source§

impl ServerMessage

Source

pub fn play_goto( request_id: Uuid, instance_id: InstanceId, goto: f64, skip_animation: Option<bool>, ) -> Self

Smart constructor for PlayAction with goto — makes invalid state (both goto and delta set) unrepresentable.

Source

pub fn play_delta( request_id: Uuid, instance_id: InstanceId, delta: f64, skip_animation: Option<bool>, ) -> Self

Smart constructor for PlayAction with delta — makes invalid state (both goto and delta set) unrepresentable.

Source

pub fn play_continue( request_id: Uuid, instance_id: InstanceId, skip_animation: Option<bool>, ) -> Self

Smart constructor for PlayAction with neither goto nor delta — continues from current step.

Trait Implementations§

Source§

impl Clone for ServerMessage

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ServerMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ServerMessage

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ServerMessage

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more