Struct LocalUri 

pub struct LocalUri<T> { /* private fields */ }

URI in format local://room_id/member_id/endpoint_id.

This kind of URI used for pointing to some element in spec (Room, Member, WebRtcPlayEndpoint, WebRtcPublishEndpoint, etc) based on state.

LocalUri can be in three states: ToRoom, ToMember, ToRoom. This is used for compile time guarantees that some LocalUri have all mandatory fields.

You also can take value from LocalUri without clone, but you have to do it consistently. For example, if you wish to get RoomId, MemberId and Endpoint ID from LocalUri in ToEndpoint state you should make this steps:

let orig_room_id = RoomId::from("room");
let orig_member_id = MemberId::from("member");
let orig_endpoint_id = EndpointId::from("endpoint");

// Create new LocalUri for endpoint.
let local_uri = LocalUri::<ToEndpoint>::new(
    orig_room_id.clone(),
    orig_member_id.clone(),
    orig_endpoint_id.clone()
);
let local_uri_clone = local_uri.clone();

// We can get reference to room_id from this LocalUri
// without taking ownership:
assert_eq!(local_uri.room_id(), &orig_room_id);

// If you want to take all IDs ownership, you should do this steps:
let (endpoint_id, member_uri) = local_uri.take_endpoint_id();
assert_eq!(endpoint_id, orig_endpoint_id);

let (member_id, room_uri) = member_uri.take_member_id();
assert_eq!(member_id, orig_member_id);

let room_id = room_uri.take_room_id();
assert_eq!(room_id, orig_room_id);

// Or simply
let (room_id, member_id, endpoint_id) = local_uri_clone.take_all();

This is necessary so that it is not possible to get the address in the wrong state (local://room_id//endpoint_id for example).

Implementations

impl LocalUri<ToRoom>

pub fn new(room_id: RoomId) -> Self

Create new reference in ToRoom state.

pub fn room_id(&self) -> &RoomId

Returns borrowed RoomId.

pub fn take_room_id(self) -> RoomId

Returns RoomId.

pub fn push_member_id(self, member_id: MemberId) -> LocalUri<ToMember>

Pushes MemberId to the end of URI and returns reference in ToMember state.

impl LocalUri<ToMember>

pub fn new(room_id: RoomId, member_id: MemberId) -> Self

Create new reference in ToMember state.

pub fn room_id(&self) -> &RoomId

Returns borrowed RoomId.

pub fn member_id(&self) -> &MemberId

Returns borrowed MemberId.

pub fn take_member_id(self) -> (MemberId, LocalUri<ToRoom>)

Return MemberId and reference in state ToRoom.

pub fn push_endpoint_id(self, endpoint_id: EndpointId) -> LocalUri<ToEndpoint>

Push endpoint ID to the end of URI and returns reference in ToEndpoint state.

pub fn take_all(self) -> (RoomId, MemberId)

Returns RoomId and MemberId.

impl LocalUri<ToEndpoint>

pub fn new( room_id: RoomId, member_id: MemberId, endpoint_id: EndpointId, ) -> Self

Creates new reference in ToEndpoint state.

pub fn room_id(&self) -> &RoomId

Returns borrowed RoomId.

pub fn member_id(&self) -> &MemberId

Returns borrowed MemberId.

pub fn endpoint_id(&self) -> &EndpointId

Returns borrowed EndpointId.

pub fn take_endpoint_id(self) -> (EndpointId, LocalUri<ToMember>)

Returns Endpoint id and reference in ToMember state.

pub fn take_all(self) -> (RoomId, MemberId, EndpointId)

Returns EndpointId, RoomId and MemberId.

Trait Implementations

impl<T: Clone> Clone for LocalUri<T>

fn clone(&self) -> LocalUri<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for LocalUri<T>

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

Formats the value using the given formatter.

impl Display for LocalUri<ToRoom>

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

Formats the value using the given formatter.

impl Display for LocalUri<ToMember>

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

Formats the value using the given formatter.

impl Display for LocalUri<ToEndpoint>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for LocalUri<T>

impl From<LocalUri<ToEndpoint>> for StatefulLocalUri

fn from(original: LocalUri<ToEndpoint>) -> StatefulLocalUri

Converts to this type from the input type.

impl From<LocalUri<ToEndpoint>> for SrcUri

fn from(uri: LocalUri<ToEndpoint>) -> Self

Converts to this type from the input type.

impl From<LocalUri<ToMember>> for StatefulLocalUri

fn from(original: LocalUri<ToMember>) -> StatefulLocalUri

Converts to this type from the input type.

impl From<LocalUri<ToRoom>> for StatefulLocalUri

fn from(original: LocalUri<ToRoom>) -> StatefulLocalUri

Converts to this type from the input type.

impl From<SrcUri> for LocalUri<ToEndpoint>

fn from(uri: SrcUri) -> Self

Converts to this type from the input type.

impl From<StatefulLocalUri> for LocalUri<ToRoom>

fn from(from: StatefulLocalUri) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for LocalUri<T>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq> PartialEq for LocalUri<T>

fn eq(&self, other: &LocalUri<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for LocalUri<T>