Skip to main content

CommunityV2

Struct CommunityV2 

Source
pub struct CommunityV2 {
Show 13 fields pub identity: CommunityIdentity, pub community_root: [u8; 32], pub root_epoch: Epoch, pub name: String, pub description: Option<String>, pub icon: Option<ImageRef>, pub banner: Option<ImageRef>, pub meta_custom: Option<Map<String, Value>>, pub meta_extra: Map<String, Value>, pub relays: Vec<String>, pub channels: Vec<ChannelV2>, pub dissolved: bool, pub created_at_ms: u64,
}
Expand description

A v2 community in memory: its self-certifying identity, base access key, and channels. Persisted via crate::db::community’s v2 helpers into the shared community tables (with the migration-65 columns).

Fields§

§identity: CommunityIdentity§community_root: [u8; 32]

The base @everyone access key at root_epoch — holding it IS membership.

§root_epoch: Epoch§name: String§description: Option<String>§icon: Option<ImageRef>

Folded vsk-0 icon/banner. Held so a local edit republishes the FULL metadata document — an edition replaces the entity, so an editor that doesn’t carry these forward wipes them for everyone (CORD-02 §6).

§banner: Option<ImageRef>§meta_custom: Option<Map<String, Value>>

Folded vsk-0 client-extensible object + unknown top-level fields — carried through our own editions verbatim (CORD-02 §6).

§meta_extra: Map<String, Value>§relays: Vec<String>§channels: Vec<ChannelV2>§dissolved: bool§created_at_ms: u64

Local wall-clock of first acquisition (ms), for display ordering.

Implementations§

Source§

impl CommunityV2

Source

pub fn from_genesis( g: &Genesis, name: &str, description: Option<String>, relays: Vec<String>, created_at_ms: u64, ) -> CommunityV2

Build the owner’s fresh community from a Genesis (the two genesis editions are the caller’s to publish). The #general channel is Public.

Source

pub fn from_bundle( bundle: &CommunityInvite, created_at_ms: u64, ) -> Result<CommunityV2, String>

Reconstruct a member’s community from an accepted invite bundle. The bundle’s owner commitment MUST already have been verified (CommunityInvite::validate) — this re-checks it fail-closed anyway. A channel is treated as Private iff its bundle key differs from the community_root (a Public channel’s “key” is the root; a Private one carries its own).

Source

pub fn id(&self) -> &CommunityId

The community_id this community is anchored on.

Source

pub fn metadata(&self) -> CommunityMetadata

The full vsk-0 metadata document rebuilt from held state — the base every local edit MUST start from, so changing one field can’t wipe the rest (CORD-02 §6), foreign clients’ custom/extra fields included.

Source

pub fn owner(&self) -> Result<PublicKey, String>

The proven owner (the identity self-certifies at construction).

Source

pub fn channel(&self, id: &ChannelId) -> Option<&ChannelV2>

Source

pub fn primary_channel(&self) -> Option<&ChannelV2>

The ONE channel the chat list surfaces for this community (multi-channel UI is a later cut, mirroring v1’s single-channel groups): a readable #general when present, else the oldest readable channel, else the first. A keyless Private channel is skipped — it can’t render a single message.

Source

pub fn channel_secret(&self, ch: &ChannelV2) -> ([u8; 32], Epoch)

The encryption secret + epoch that address a channel’s Chat Plane: the community_root at root_epoch for a Public channel, the channel’s own key at its own epoch for a Private one (CORD-03 §1).

Source

pub fn channel_read_coords(&self, ch: &ChannelV2) -> Vec<([u8; 32], Epoch)>

Every (secret, epoch) pair to query for a channel’s history — for the first cut this is the single current head; the multi-epoch archive (across rekeys) layers on once rotation lands in the service.

Source

pub fn to_summary_json(&self) -> Value

The untyped summary the facade hands the SDK (protocol-agnostic shape + a version tell). Kept deliberately close to v1’s summary keys so a consumer treats both uniformly.

Trait Implementations§

Source§

impl Clone for CommunityV2

Source§

fn clone(&self) -> CommunityV2

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 CommunityV2

Source§

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

Formats the value using the given formatter. 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<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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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