Struct wit_parser::PackageDocs

pub struct PackageDocs { /* private fields */ }

Represents serializable doc comments parsed from a WIT package.

Implementations

impl PackageDocs

pub const SECTION_NAME: &'static str = "package-docs"

pub fn extract(resolve: &Resolve, package: PackageId) -> Self

Extract package docs for the given package.

pub fn inject(&self, resolve: &mut Resolve, package: PackageId) -> Result<()>

Inject package docs for the given package.

This will override any existing docs in the Resolve.

pub fn encode(&self) -> Result<Vec<u8>>

Encode package docs as a package-docs custom section.

pub fn decode(data: &[u8]) -> Result<Self>

Decode package docs from package-docs custom section content.

Trait Implementations

impl<'de> Deserialize<'de> for PackageDocs

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PackageDocs

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

where __S: Serializer,

Serialize this value into the given Serde serializer.