Struct serde_sarif::sarif::Region

pub struct Region {
    pub byte_length: Option<i64>,
    pub byte_offset: Option<i64>,
    pub char_length: Option<i64>,
    pub char_offset: Option<i64>,
    pub end_column: Option<i64>,
    pub end_line: Option<i64>,
    pub message: Option<Message>,
    pub properties: Option<PropertyBag>,
    pub snippet: Option<ArtifactContent>,
    pub source_language: Option<String>,
    pub start_column: Option<i64>,
    pub start_line: Option<i64>,
}

Expand description

A region within an artifact where a result was detected.

Fields§

§byte_length: Option<i64>

The length of the region in bytes.

§byte_offset: Option<i64>

The zero-based offset from the beginning of the artifact of the first byte in the region.

§char_length: Option<i64>

The length of the region in characters.

§char_offset: Option<i64>

The zero-based offset from the beginning of the artifact of the first character in the region.

§end_column: Option<i64>

The column number of the character following the end of the region.

§end_line: Option<i64>

The line number of the last character in the region.

§message: Option<Message>

A message relevant to the region.

§properties: Option<PropertyBag>

Key/value pairs that provide additional information about the region.

§snippet: Option<ArtifactContent>

The portion of the artifact contents within the specified region.

§source_language: Option<String>

Specifies the source language, if any, of the portion of the artifact specified by the region object.

§start_column: Option<i64>

The column number of the first character in the region.

§start_line: Option<i64>

The line number of the first character in the region.

Implementations§

impl Region

pub fn builder() -> RegionBuilder<((), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building Region. On the builder, call .byte_length(...)(optional), .byte_offset(...)(optional), .char_length(...)(optional), .char_offset(...)(optional), .end_column(...)(optional), .end_line(...)(optional), .message(...)(optional), .properties(...)(optional), .snippet(...)(optional), .source_language(...)(optional), .start_column(...)(optional), .start_line(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Region.

Trait Implementations§

impl Clone for Region

fn clone(&self) -> Region

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Region

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

Formats the value using the given formatter. Read more

impl Default for Region

fn default() -> Region

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for Region

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for Region

fn eq(&self, other: &Region) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

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 Region

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for Region

Auto Trait Implementations§

impl Freeze for Region

impl RefUnwindSafe for Region

impl Send for Region

impl Sync for Region

impl Unpin for Region

impl UnwindSafe for Region

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,