Struct pallet_spaces::Space

pub struct Space<T: Trait> {
    pub id: SpaceId,
    pub created: WhoAndWhen<T>,
    pub updated: Option<WhoAndWhen<T>>,
    pub owner: T::AccountId,
    pub parent_id: Option<SpaceId>,
    pub handle: Option<Vec<u8>>,
    pub content: Content,
    pub hidden: bool,
    pub posts_count: u32,
    pub hidden_posts_count: u32,
    pub followers_count: u32,
    pub score: i32,
    pub permissions: Option<SpacePermissions>,
}

Information about a space’s owner, its’ content, visibility and custom permissions.

Fields

id: SpaceId

Unique sequential identifier of a space. Examples of space ids: 1, 2, 3, and so on.

created: WhoAndWhen<T>

updated: Option<WhoAndWhen<T>>

owner: T::AccountId

The current owner of a given space.

parent_id: Option<SpaceId>

handle: Option<Vec<u8>>

Unique alpha-numeric identifier that can be used in a space’s URL. Handle can only contain numbers, letter and underscore: 0-9, a-z, _.

content: Content

hidden: bool

Hidden field is used to recommend to end clients (web and mobile apps) that a particular space and its’ posts should not be shown.

posts_count: u32

The total number of posts in a given space.

hidden_posts_count: u32

The number of hidden posts in a given space.

followers_count: u32

The number of account following a given space.

score: i32

permissions: Option<SpacePermissions>

This allows you to override Subsocial’s default permissions by enabling or disabling role permissions.

Implementations

impl<T: Trait> Space<T>

pub fn new(
    id: SpaceId,
    parent_id: Option<SpaceId>,
    created_by: T::AccountId,
    content: Content,
    handle: Option<Vec<u8>>,
    permissions: Option<SpacePermissions>
) -> Self

pub fn is_owner(&self, account: &T::AccountId) -> bool

pub fn is_follower(&self, account: &T::AccountId) -> bool

pub fn ensure_space_owner(&self, account: T::AccountId) -> DispatchResult

pub fn inc_posts(&mut self)

pub fn dec_posts(&mut self)

pub fn inc_hidden_posts(&mut self)

pub fn dec_hidden_posts(&mut self)

pub fn inc_followers(&mut self)

pub fn dec_followers(&mut self)

pub fn change_score(&mut self, diff: i16)

pub fn try_get_parent(&self) -> Result<SpaceId, DispatchError>

pub fn is_public(&self) -> bool

pub fn is_unlisted(&self) -> bool

Trait Implementations

impl<T: Clone + Trait> Clone for Space<T> where
    T::AccountId: Clone, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Trait> Debug for Space<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T: Trait> Decode for Space<T> where
    WhoAndWhen<T>: Decode,
    WhoAndWhen<T>: Decode,
    Option<WhoAndWhen<T>>: Decode,
    Option<WhoAndWhen<T>>: Decode,
    T::AccountId: Decode,
    T::AccountId: Decode, 

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

impl<T: Trait> Encode for Space<T> where
    WhoAndWhen<T>: Encode,
    WhoAndWhen<T>: Encode,
    Option<WhoAndWhen<T>>: Encode,
    Option<WhoAndWhen<T>>: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode, 

fn encode_to<__CodecOutputEdqy: Output>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

Convert self to a slice and append it to the destination.

pub fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

pub fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

pub fn using_encoded<R, F>(&self, f: F) -> R where
    F: FnOnce(&[u8]) -> R, 

Convert self to a slice and then invoke the given closure with it.

impl<T: Trait> EncodeLike<Space<T>> for Space<T> where
    WhoAndWhen<T>: Encode,
    WhoAndWhen<T>: Encode,
    Option<WhoAndWhen<T>>: Encode,
    Option<WhoAndWhen<T>>: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode, 

impl<T: Eq + Trait> Eq for Space<T> where
    T::AccountId: Eq, 

impl<T: Trait> From<Space<T>> for FlatSpace<T::AccountId, T::BlockNumber>

fn from(from: Space<T>) -> Self

Performs the conversion.

impl<T: PartialEq + Trait> PartialEq<Space<T>> for Space<T> where
    T::AccountId: PartialEq, 

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Space<T>) -> bool

This method tests for !=.

impl<T: Trait> StorageMap<u64, Space<T>> for SpaceById<T>

type Query = Option<Space<T>>

The type that get/take returns.

type Hasher = Twox64Concat

Hasher. Used for generating final key.

fn module_prefix() -> &'static [u8]

Module prefix. Used for generating final key.

fn storage_prefix() -> &'static [u8]

Storage prefix. Used for generating final key.

fn from_optional_value_to_query(v: Option<Space<T>>) -> Self::Query

Convert an optional value retrieved from storage to the type queried.

fn from_query_to_optional_value(v: Self::Query) -> Option<Space<T>>

Convert a query to an optional value into storage.

pub fn prefix_hash() -> Vec<u8, Global>

The full prefix; just the hash of module_prefix concatenated to the hash of storage_prefix.

pub fn storage_map_final_key<KeyArg>(key: KeyArg) -> Vec<u8, Global> where
    KeyArg: EncodeLike<K>, 

Generate the full key used in top storage.

impl<T: Trait> StoragePrefixedMap<Space<T>> for SpaceById<T>

fn module_prefix() -> &'static [u8]

Module prefix. Used for generating final key.

fn storage_prefix() -> &'static [u8]

Storage prefix. Used for generating final key.

pub fn final_prefix() -> [u8; 32]

Final full prefix that prefixes all keys.

pub fn remove_all()

Remove all value of the storage.

pub fn iter_values() -> PrefixIterator<Value>

Iter over all value of the storage.

pub fn translate_values<OldValue, F>(f: F) where
    F: Fn(OldValue) -> Option<Value>,
    OldValue: Decode, 

Translate the values of all elements by a function f, in the map in no particular order. By returning None from f for an element, you’ll remove it from the map.

impl<T: Trait> StructuralEq for Space<T>

impl<T: Trait> StructuralPartialEq for Space<T>