Skip to main content

AvatarRedaction

Struct AvatarRedaction 

Source
#[non_exhaustive]
pub struct AvatarRedaction { pub position: Option<Position>, pub orientation: Option<Orientation>, pub world_state_keys: Vec<String>, pub region_state_keys: Vec<String>, }
Expand description

The properties of one SceneAvatar withheld from a caller (jmap-chat-spec 93f2258 §Avatar Visibility): “Only position, orientation, worldState, and regionState can be withheld.”

For position and orientation the deployment supplies the value returned instead, one “that tells the caller nothing it may not know, such as the region’s spawnPosition and spawnOrientation, or the values at the time the avatar was last visible to the caller”. For worldState and regionState “the server leaves out the withheld top-level keys”. The default withholds nothing.

use jmap_scene_server::AvatarRedaction;

let mut redaction = AvatarRedaction::default();
redaction.position = Some([0.0, 0.0, 5.0]);
redaction.region_state_keys = vec!["money".to_owned()];
assert_eq!(redaction.withheld(), ["position", "regionState"]);

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§position: Option<Position>

The position returned instead of the stored one; None to return the stored one.

§orientation: Option<Orientation>

The orientation returned instead of the stored one; None to return the stored one.

§world_state_keys: Vec<String>

The top-level worldState keys left out.

§region_state_keys: Vec<String>

The top-level regionState keys left out.

Implementations§

Source§

impl AvatarRedaction

Source

pub fn apply(&self, avatar: &mut SceneAvatar)

Apply this redaction to avatar: replace position and orientation where set, and remove the listed worldState and regionState keys. A null or absent state object is left as it is.

Source

pub fn withheld(&self) -> Vec<&'static str>

The SceneAvatar property names this redaction withholds, in the order position, orientation, worldState, regionState.

Trait Implementations§

Source§

impl Clone for AvatarRedaction

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 AvatarRedaction

Source§

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

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

impl Default for AvatarRedaction

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for AvatarRedaction

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AvatarRedaction

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<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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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