Struct Annotations 

#[non_exhaustive]
pub struct Annotations {
    pub description: String,
    /* private fields */
}

Represents the annotation of a block or a chunk.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

description: String

The description of the content with this annotation.

Implementations

impl Annotations

pub fn new() -> Self

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

Example

let x = Annotations::new().set_description("example");

Trait Implementations

impl Clone for Annotations

fn clone(&self) -> Annotations

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Annotations

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

Formats the value using the given formatter.

impl Default for Annotations

fn default() -> Annotations

Returns the “default value” for a type.

impl Message for Annotations

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Annotations

fn eq(&self, other: &Annotations) -> 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 StructuralPartialEq for Annotations