Struct Source

pub struct Source {
    pub name: Option<String>,
    pub path: Option<String>,
    pub source_reference: Option<i32>,
    pub presentation_hint: Option<SourcePresentationHint>,
    pub origin: Option<String>,
    pub sources: Vec<Source>,
    pub adapter_data: Option<Value>,
    pub checksums: Vec<Checksum>,
    /* private fields */
}

A Source is a descriptor for source code.

It is returned from the debug adapter as part of a StackFrame and it is used by clients when specifying breakpoints.

Fields

name: Option<String>

The short name of the source. Every source returned from the debug adapter has a name.

When sending a source to the debug adapter this name is optional.

path: Option<String>

The path of the source to be shown in the UI.

It is only used to locate and load the content of the source if no sourceReference is specified (or its value is 0).

source_reference: Option<i32>

If sourceReference > 0 the contents of the source must be retrieved through the SourceRequest (even if a path is specified).

A sourceReference is only valid for a session, so it must not be used to persist a source.

The value should be less than or equal to 2147483647 (2^31-1).

presentation_hint: Option<SourcePresentationHint>

An optional hint for how to present the source in the UI.

A value of ‘deemphasize’ can be used to indicate that the source is not available or that it is skipped on stepping.

origin: Option<String>

The (optional) origin of this source: possible values ‘internal module’, ‘inlined content from source map’, etc.

sources: Vec<Source>

An optional list of sources that are related to this source. These may be the source that generated this source.

adapter_data: Option<Value>

Optional data that a debug adapter might want to loop through the client.

The client should leave the data intact and persist it across sessions. The client should not interpret the data.

checksums: Vec<Checksum>

The checksums associated with this file.

Implementations

impl Source

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

Create a builder for building Source. On the builder, call .name(...)(optional), .path(...)(optional), .source_reference(...)(optional), .presentation_hint(...)(optional), .origin(...)(optional), .sources(...)(optional), .adapter_data(...)(optional), .checksums(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Source.

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Source

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Source

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Source

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Source

impl StructuralPartialEq for Source