Struct google_api_proto::google::genomics::v1::Annotation

pub struct Annotation {
    pub id: String,
    pub annotation_set_id: String,
    pub name: String,
    pub reference_id: String,
    pub reference_name: String,
    pub start: i64,
    pub end: i64,
    pub reverse_strand: bool,
    pub type: i32,
    pub info: BTreeMap<String, ListValue>,
    pub value: Option<Value>,
}

An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are GENE and VARIANT.

Fields

id: String

The server-generated annotation ID, unique across all annotations.

annotation_set_id: String

The annotation set to which this annotation belongs.

name: String

The display name of this annotation.

reference_id: String

The ID of the Google Genomics reference associated with this range.

reference_name: String

The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.

start: i64

The start position of the range on the reference, 0-based inclusive.

end: i64

The end position of the range on the reference, 0-based exclusive.

reverse_strand: bool

Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.

type: i32

The data type for this annotation. Must match the containing annotation set’s type.

info: BTreeMap<String, ListValue>

A map of additional read alignment information. This must be of the form map<string, string[]> (string key mapping to a list of string values).

value: Option<Value>

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.

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Annotation