Struct Mdoc 

pub struct Mdoc { /* private fields */ }

=========================== Root MDOC (owned, editable)

Implementations

impl Mdoc

pub fn from_reader<R: BufRead>(reader: R) -> Result<Self, ParseError>

Streaming parse into an owned, editable MDOC

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self, ParseError>

pub fn header(&self) -> &[HeaderEntry]

pub fn tilt_series(&self) -> &[ZBlock]

pub fn tilt_image(&self, z: usize) -> Option<&ZBlock>

pub fn tilt_image_mut(&mut self, z: usize) -> Option<&mut ZBlock>

pub fn write<W: Write>(&self, w: W) -> Result<()>

pub fn write_lossless<W: Write>(&self, w: W) -> Result<()>

Write with original formatting (lossless round-trip)

This method writes the MDOC file using the original raw values if they were captured, ensuring a true lossless round-trip.

impl Mdoc

pub fn normalize_spaces(&mut self)

Normalize multiple spaces to single space in all values

pub fn to_json(&self) -> Result<String, Error>

pub fn from_json(json: &str) -> Result<Self, Error>

pub fn normalize_format(&mut self)

Normalize all formats in the MDOC file

This method combines space normalization and key-value format normalization. It handles various input styles and produces a consistent output format.

Handles formats like:

• Defocus = -5.0; (standard)
• Defocus=-5.0; (no spaces around =)
• Defocus = -5.0 (no semicolon)
• Key = value with spaces; (extra spaces)
• "Value" (quoted)

Returns normalized format: Key = value;

Note: Raw values are automatically captured during parsing, so lossless round-trip is always available via write_lossless().

impl Mdoc

pub fn add_tilt_image(&mut self, z: usize) -> &mut ZBlock

pub fn remove_tilt_image(&mut self, z: usize) -> bool

pub fn update_field( &mut self, z: usize, key: impl Into<String>, value: impl Into<String>, ) -> bool

pub fn validate(&self) -> Result<(), Vec<ValidationError>>

Trait Implementations

impl Clone for Mdoc

fn clone(&self) -> Mdoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mdoc

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Mdoc

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Mdoc

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

Formats the value using the given formatter.

impl Serialize for Mdoc

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

where __S: Serializer,

Serialize this value into the given Serde serializer.