Struct scayl::format::sarif::Region

source · [−]

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.

Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region.

Specifies a portion of the artifact.

The region of the artifact to delete.

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.

Trait Implementations

impl Debug for Region

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

Formats the value using the given formatter. 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 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

Auto Trait Implementations

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

const: unstable · source

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, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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.

const: unstable · source

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

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

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