Struct ChannelPreviewRecord 

pub struct ChannelPreviewRecord {
    pub kind: ChannelKindRecord,
    pub canonical_name: Option<String>,
    pub key: Vec<u8>,
    pub channel_id: Vec<u8>,
    pub tint: Vec<u8>,
    pub display_name: Option<String>,
    pub max_flood_hops: Option<u8>,
    pub region: Option<Vec<u8>>,
}

Safe, non-mutating preview of a channel the user is about to join.

key is secret membership material for a ChannelKindRecord::PrivateKey channel: callers must store it with identity-key protection and must not place it in ordinary application records.

Fields

kind: ChannelKindRecord

canonical_name: Option<String>

Canonicalized (ASCII-lowercased) name for a named channel. The UI should show this when it differs from what the user typed, because it — not the input — is what determines the key.

key: Vec<u8>

The 32-octet channel key.

channel_id: Vec<u8>

The two-octet derived channel identifier. This is a hint, not an identity: distinct keys may derive the same value, and receivers resolve collisions by trial decryption.

tint: Vec<u8>

Three octets for presentation — a deterministic colour for the channel. The first two are the identifier above.

display_name: Option<String>

Suggested local display name from the invitation (n=), decoded.

max_flood_hops: Option<u8>

Recommended flood-hop ceiling from the invitation (mh=).

region: Option<Vec<u8>>

Recommended region from the invitation (r=), as a two-octet code. Absent when the invitation named a region that does not parse.

Trait Implementations

impl Clone for ChannelPreviewRecord

fn clone(&self) -> ChannelPreviewRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for ChannelPreviewRecord

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for ChannelPreviewRecord

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for ChannelPreviewRecord

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a MetadataBuffer.

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl<UT> Lift<UT> for ChannelPreviewRecord

type FfiType = <ChannelPreviewRecord as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for ChannelPreviewRecord

type LiftType = ChannelPreviewRecord

impl<UT> LiftReturn<UT> for ChannelPreviewRecord

type ReturnType = <ChannelPreviewRecord as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for ChannelPreviewRecord

type FfiType = <ChannelPreviewRecord as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for ChannelPreviewRecord

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for ChannelPreviewRecord

type ReturnType = <ChannelPreviewRecord as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl PartialEq for ChannelPreviewRecord

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<UT> TypeId<UT> for ChannelPreviewRecord

const TYPE_ID_META: MetadataBuffer

impl Eq for ChannelPreviewRecord

impl StructuralPartialEq for ChannelPreviewRecord