Struct ValidatedAdfDocument 

pub struct ValidatedAdfDocument(/* private fields */);

An AdfDocument that has passed nesting validation against the upstream content model.

Constructing one is the only way to satisfy the type signatures of the API send functions in crate::atlassian::client and crate::atlassian::confluence_api. This makes “I forgot to validate” a compile error rather than a runtime opaque-500 error.

Deref<Target = AdfDocument> and a delegated Serialize impl let callers continue to use the validated document anywhere a &AdfDocument or serialized JSON value is needed.

Implementations

impl ValidatedAdfDocument

pub fn try_new(doc: AdfDocument) -> Result<Self, AdfValidationError>

Validates doc against the upstream ADF content model and wraps it on success.

Errors

Returns AdfValidationError if doc contains any disallowed nesting per the schema in crate::atlassian::adf_schema.

pub fn try_new_with_source( doc: AdfDocument, source: Option<&str>, ) -> Result<Self, AdfValidationError>

Like Self::try_new, but keeps source (the JFM markdown doc was converted from, when applicable) so a validation failure reports the offending run’s 1-based line:column. Pass None when there is no JFM source (e.g. ADF-format input). See issue #1087.

Errors

Returns AdfValidationError if doc contains any disallowed nesting per the schema in crate::atlassian::adf_schema.

pub fn empty() -> Self

Returns a trivially-valid empty document without invoking the validator. Useful for tests and for code paths that need an “unset” placeholder.

Trait Implementations

impl Clone for ValidatedAdfDocument

fn clone(&self) -> ValidatedAdfDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidatedAdfDocument

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

Formats the value using the given formatter.

impl Deref for ValidatedAdfDocument

type Target = AdfDocument

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl PartialEq for ValidatedAdfDocument

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

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ValidatedAdfDocument