Struct CodeDescription 

#[non_exhaustive]
pub struct CodeDescription {
    pub href: Url,
}

An advisory/rule URL attached to a Diagnostic’s code, field-for-field identical to tower_lsp_server::ls_types::CodeDescription but carrying no dependency on tower-lsp-server.

Examples

use deps_core::diagnostic::CodeDescription;
use url::Url;

let href = Url::parse("https://osv.dev/GHSA-xxxx").unwrap();
let code_description = CodeDescription::new(href.clone());
assert_eq!(code_description.href, href);

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.

href: Url

URI describing the diagnostic’s code, e.g. an OSV advisory page.

Implementations

impl CodeDescription

pub const fn new(href: Url) -> Self

Builds a CodeDescription from its href field.

Needed because Self is #[non_exhaustive]: a struct literal only works inside this crate, so every other crate must call this constructor instead.

Examples

use deps_core::diagnostic::CodeDescription;
use url::Url;

let code_description = CodeDescription::new(Url::parse("https://example.com").unwrap());
assert_eq!(code_description.href.as_str(), "https://example.com/");

Trait Implementations

impl Clone for CodeDescription

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeDescription

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

Formats the value using the given formatter.

impl Eq for CodeDescription

impl PartialEq for CodeDescription

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CodeDescription