Struct gapi_grpc::google::monitoring::v3::TextLocator

[+] Show declaration

pub struct TextLocator {
    pub source: String,
    pub start_position: Option<Position>,
    pub end_position: Option<Position>,
    pub nested_locator: Option<Box<TextLocator>>,
    pub nesting_reason: String,
}

[−] Expand description

A locator for text. Indicates a particular part of the text of a request or of an object referenced in the request.

For example, suppose the request field text contains:

text: “The quick brown fox jumps over the lazy dog.”

Then the locator:

source: “text” start_position { line: 1 column: 17 } end_position { line: 1 column: 19 }

refers to the part of the text: “fox”.

Fields

source: String

[−] Expand description

The source of the text. The source may be a field in the request, in which case its format is the format of the google.rpc.BadRequest.FieldViolation.field field in https://cloud.google.com/apis/design/errors#error_details. It may also be be a source other than the request field (e.g. a macro definition referenced in the text of the query), in which case this is the name of the source (e.g. the macro name).

start_position: Option<Position>

[−] Expand description

The position of the first byte within the text.

end_position: Option<Position>

[−] Expand description

The position of the last byte within the text.

nested_locator: Option<Box<TextLocator>>

[−] Expand description

If source, start_position, and end_position describe a call on some object (e.g. a macro in the time series query language text) and a location is to be designated in that object’s text, nested_locator identifies the location within that object.

nesting_reason: String

[−] Expand description

When nested_locator is set, this field gives the reason for the nesting. Usually, the reason is a macro invocation. In that case, the macro name (including the leading ‘@’) signals the location of the macro call in the text and a macro argument name (including the leading ‘$’) signals the location of the macro argument inside the macro body that got substituted away.

Trait Implementations

impl Clone for TextLocator[+]

[+] Show hidden undocumented items

fn clone(&self) -> TextLocator[−]

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextLocator[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for TextLocator[+]

[+] Show hidden undocumented items

fn default() -> TextLocator[−]

Returns the “default value” for a type.

impl Message for TextLocator[+]

[+] Show hidden undocumented items

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, [−]

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, [−]

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, [−]

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, [−]

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

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, [−]

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

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, [−]

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

impl PartialEq<TextLocator> for TextLocator[+]

[+] Show hidden undocumented items

fn eq(&self, other: &TextLocator) -> bool[−]

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

fn ne(&self, other: &TextLocator) -> bool[−]

This method tests for !=.

impl StructuralPartialEq for TextLocator