Struct symbolic_debuginfo::sourcebundle::SourceFileInfo

pub struct SourceFileInfo { /* private fields */ }

Meta data information of a file in a SourceBundle.

Implementations

impl SourceFileInfo

pub fn new() -> Self

Creates default file information.

pub fn ty(&self) -> Option<SourceFileType>

Returns the type of the source file.

pub fn set_ty(&mut self, ty: SourceFileType)

Sets the type of the source file.

pub fn path(&self) -> Option<&str>

Returns the absolute file system path of this file.

pub fn set_path(&mut self, path: String)

Sets the absolute file system path of this file.

pub fn url(&self) -> Option<&str>

Returns the web URL that of this file.

pub fn set_url(&mut self, url: String)

Sets the web URL of this file.

pub fn headers(&self) -> impl Iterator<Item = (&str, &str)>

Iterates over all attributes represented as headers.

pub fn header(&self, header: &str) -> Option<&str>

Retrieves the specified header, if it exists.

pub fn add_header(&mut self, header: String, value: String)

Adds a custom attribute following header conventions.

Header keys are converted to lowercase before writing as this is the canonical format for headers. However, the file format does support headers to be case insensitive and they will be lower cased upon reading.

Headers on files are primarily be used to add auxiliary information to files. The following headers are known and processed:

• debug-id: see debug_id
• sourcemap (and x-sourcemap): see source_mapping_url

pub fn debug_id(&self) -> Option<DebugId>

The debug ID of this minified source or sourcemap if it has any.

Files have a debug ID if they have a header with the key debug-id. At present debug IDs in source bundles are only ever given to minified source files.

pub fn source_mapping_url(&self) -> Option<&str>

The source mapping URL of the given minified source.

Files have a source mapping URL if they have a header with the key sourcemap (or the x-sourcemap legacy header) as part the source map specification.

pub fn is_empty(&self) -> bool

Returns true if this instance does not carry any information.

Trait Implementations

impl Clone for SourceFileInfo

fn clone(&self) -> SourceFileInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceFileInfo

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

Formats the value using the given formatter.

impl Default for SourceFileInfo

fn default() -> SourceFileInfo

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SourceFileInfo

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

Deserialize this value from the given Serde deserializer.

impl Serialize for SourceFileInfo

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

Serialize this value into the given Serde serializer.