Struct Annotation

pub struct Annotation {
    pub type: i32,
    pub start_index: Option<i32>,
    pub length: i32,
    pub metadata: Option<Metadata>,
}

Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see Format text messages.

Example plain-text message body:

Hello @FooBot how are you!"

The corresponding annotations metadata:

"annotations":[{
   "type":"USER_MENTION",
   "startIndex":6,
   "length":7,
   "userMention": {
     "user": {
       "name":"users/{user}",
       "displayName":"FooBot",
       "avatarUrl":"<https://goo.gl/aeDtrS",>
       "type":"BOT"
     },
     "type":"MENTION"
    }
}]

Fields

type: i32

The type of this annotation.

start_index: Option<i32>

Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to.

length: i32

Length of the substring in the plain-text message body this annotation corresponds to.

metadata: Option<Metadata>

Additional metadata about the annotation.

Implementations

impl Annotation

pub fn type(&self) -> AnnotationType

Returns the enum value of type, or the default if the field is set to an invalid enum value.

pub fn set_type(&mut self, value: AnnotationType)

Sets type to the provided enum value.

pub fn start_index(&self) -> i32

Returns the value of start_index, or the default value if start_index is unset.

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Annotation

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

Formats the value using the given formatter.

impl Default for Annotation

fn default() -> Self

Returns the “default value” for a type.

impl Message for Annotation

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Annotation

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