Trait Mirror 

pub trait Mirror: Sized + 'static {
    type View<'a>: From<Row<'a, Self>>;
    type Writer<'w>: From<RowWriter<'w, Self>>;

    const NAME: &'static str;
    const OWNER: Option<&'static str>;
    const SPACE: &'static str;
    const ALL: u64;
    const FAMILY: bool = false;
    const CLOCK: Clock = Clock::Server;

    // Required methods
    fn fields() -> Vec<FieldSpec>;
    fn read(row: &Row<'_, Self>) -> Self;
    fn write(&self, row: &mut RowWriter<'_, Self>);

    // Provided methods
    fn address() -> String { ... }
    fn spec() -> MirrorSpec { ... }
    fn declare(fields: u64, rate: Rate) -> Result<Mirrored<Self>, Diagnostic> { ... }
    fn declare_scoped<S: Schema>(
        scope: &S,
        fields: u64,
        rate: Rate,
    ) -> Result<Mirrored<Self>, Diagnostic> { ... }
    fn declare_in<S: Schema>(
        member: &str,
        scope: Option<&S>,
        fields: u64,
        rate: Rate,
    ) -> Result<Mirrored<Self>, Diagnostic> { ... }
}

A mirror’s row type (#[yog_mirror] implements it).

Required Associated Constants

const NAME: &'static str

Its name’s last part: yog:mirror/<mod>/<NAME>.

const OWNER: Option<&'static str>

The mod providing it; None: this one.

const SPACE: &'static str

Its key space (yog_ids::key_space::*).

const ALL: u64

Every field’s bit.

Provided Associated Constants

const FAMILY: bool = false

Its key space is a family (a member each parameter, declare_in).

const CLOCK: Clock = Clock::Server

Whose ticks it’s written after (the server’s, unless it’s a client’s view).

Required Associated Types

type View<'a>: From<Row<'a, Self>>

A row read.

type Writer<'w>: From<RowWriter<'w, Self>>

A row written.

Required Methods

fn fields() -> Vec<FieldSpec>

Its fields, in order.

fn read(row: &Row<'_, Self>) -> Self

The whole row (a field not asked for reads as its default).

fn write(&self, row: &mut RowWriter<'_, Self>)

Every due field of row set from self.

Provided Methods

fn address() -> String

Its address.

fn spec() -> MirrorSpec

fn declare(fields: u64, rate: Rate) -> Result<Mirrored<Self>, Diagnostic>

Asks for fields (its bit consts or-ed) at rate.

fn declare_scoped<S: Schema>( scope: &S, fields: u64, rate: Rate, ) -> Result<Mirrored<Self>, Diagnostic>

Mirror::declare covering scope (its scope type: a BlockScope…) — a mirror that isn’t a family’s.

fn declare_in<S: Schema>( member: &str, scope: Option<&S>, fields: u64, rate: Rate, ) -> Result<Mirrored<Self>, Diagnostic>

Mirror::declare in member member of its family (a dimension: minecraft:overworld), covering scope (its scope type: a BlockScope…).

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl Mirror for Blocks

const NAME: &'static str = "blocks"

const ALL: u64 = 1u64

const OWNER: Option<&'static str> = None

const SPACE: &'static str

const CLOCK: Clock

type View<'a> = BlocksView<'a>

type Writer<'w> = BlocksWriter<'w>

impl Mirror for ClientBlocks

const NAME: &'static str = "client_blocks"

const ALL: u64 = 7u64

const OWNER: Option<&'static str> = None

const SPACE: &'static str

const CLOCK: Clock

type View<'a> = ClientBlocksView<'a>

type Writer<'w> = ClientBlocksWriter<'w>

impl Mirror for ClientEntities

const NAME: &'static str = "client_entities"

const ALL: u64 = 511u64

const OWNER: Option<&'static str> = None

const SPACE: &'static str

const CLOCK: Clock

type View<'a> = ClientEntitiesView<'a>

type Writer<'w> = ClientEntitiesWriter<'w>

impl Mirror for Entities

const NAME: &'static str = "entities"

const ALL: u64 = 127u64

const OWNER: Option<&'static str> = None

const SPACE: &'static str

const CLOCK: Clock

type View<'a> = EntitiesView<'a>

type Writer<'w> = EntitiesWriter<'w>

impl Mirror for Players

const NAME: &'static str = "players"

const ALL: u64 = 1u64

const OWNER: Option<&'static str> = None

const SPACE: &'static str

const CLOCK: Clock

type View<'a> = PlayersView<'a>

type Writer<'w> = PlayersWriter<'w>