Struct TextLocator

#[non_exhaustive]
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,
}

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 (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.

source: String

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>

The position of the first byte within the text.

end_position: Option<Position>

The position of the last byte within the text.

nested_locator: Option<Box<TextLocator>>

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

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.

Implementations

impl TextLocator

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

Sets the value of source.

pub fn set_start_position<T: Into<Option<Position>>>(self, v: T) -> Self

Sets the value of start_position.

pub fn set_end_position<T: Into<Option<Position>>>(self, v: T) -> Self

Sets the value of end_position.

pub fn set_nested_locator<T: Into<Option<Box<TextLocator>>>>(self, v: T) -> Self

Sets the value of nested_locator.

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

Sets the value of nesting_reason.

Trait Implementations

impl Clone for TextLocator

fn clone(&self) -> TextLocator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextLocator

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

Formats the value using the given formatter.

impl Default for TextLocator

fn default() -> TextLocator

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TextLocator

where TextLocator: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for TextLocator

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TextLocator

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TextLocator