mooncakes.io

batch
→
cmd
→
converter
→
core
→
document
→
docx
→
html
→
inspect
→
opc
→
paths
→
sdk_validity
→
splice
→
style_map
→
xml
→
zip
→
README
U
BreakType
U
Comment
U
ConversionResult
U
DocumentElement
U
DocumentMatcher
U
DocxPackageResult
U
DocxReadResult
U
DocxXmlResourceLimit
U
HtmlNode
U
HtmlPathElement
U
Image
U
ImageConversion
U
Indent
U
Message
U
Note
U
Numbering
U
OutputFormat
U
ParagraphProperties
U
RunProperties
U
StyleMapParseResult
U
StyleMapping
U
StyleNameMatcher
U
TableProperties
U
VerticalAlignment
U
XmlElement
U
XmlNode
U
ZipArchive
E
DocxError
- ::equalDocxError::equal
- ::not_equalDocxError::not_equal
- ::to_reprDocxError::to_repr
V
bookmark_start
V
checkbox
V
column_break
V
combine_results
V
comment
V
comment_reference
V
comment_reply
V
comment_spec
V
convert
V
convert_document
V
convert_document_to_html
V
convert_document_to_markdown
V
convert_to_html
V
convert_to_markdown
V
data_uri_image
V
data_uri_image_converter
V
default_style_map_lines
V
document
V
document_descendants
V
document_descendants_where
V
embed_style_map
V
error
V
escape_html
V
escape_html_attribute
V
escape_markdown_text
V
extract_raw_text
V
extract_raw_text_from_document
V
fresh_html_element
V
html_element
V
html_text
V
hyperlink
V
identity_document_transform
V
image
V
image_conversion
V
img_element
V
indent
V
inline_image
V
join_zip_path
V
line_break
V
new_blank_docx
V
note
V
note_reference
V
note_spec
V
numbering
V
open_zip
V
page_break
V
paragraph
V
paragraph_properties
V
parse_style_map
V
parse_style_map_string
V
read_docx
V
read_docx_annotated
V
read_docx_package
V
read_docx_with_messages
V
read_embedded_style_map
V
read_style_map
V
read_style_map_string
V
read_style_mapping
V
read_xml_string
V
run
V
run_properties
V
simplify_html
V
split_zip_path
V
success
V
tab
V
table
V
table_cell
V
table_properties
V
table_row
V
text
V
transform_elements
V
transform_paragraphs
V
transform_runs
V
warning
V
write_docx
V
write_docx_with_annotations
V
write_docx_with_comments
V
write_html
V
write_markdown
V
write_xml_string
V
xml_element
V
xml_text
V
zip_archive

README

bobzhang/docx2html/core does not have a README file

#
DocxError

pub(all) suberror DocxError {
  InvalidZip(message~ : String)
  InvalidXml(message~ : String)
  MissingPart(message~ : String)
  Unsupported(message~ : String)
  ResourceLimit(limit~ : DocxXmlResourceLimit, message~ : String)
  WriteResourceLimit(kind~ : String, limit~ : Int64, actual~ : Int64, message~ : String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Errors raised for invalid archives, invalid XML, missing parts, or unsupported input.

#
DocxError::description

source

fn DocxError::description(self : DocxError) -> String

Returns the stable caller-facing message for every DOCX error variant.

#
DocxError::equal

source

#deprecated("implicit trait-method promotion is being removed; call via the trait")
fn DocxError::equal(DocxError, DocxError) -> Bool

#
DocxError::not_equal

source

#deprecated("implicit trait-method promotion is being removed; call via the trait")
fn DocxError::not_equal(x : DocxError, y : DocxError) -> Bool

#
DocxError::to_repr

source

#deprecated("implicit trait-method promotion is being removed; call via the trait")
fn DocxError::to_repr(DocxError) -> @moonbitlang/core/debug.Repr
Repr

#
DocxError::xml_resource_limit

source

fn DocxError::xml_resource_limit(self : DocxError) -> DocxXmlResourceLimit?

Returns the typed XML resource discriminator, if this error represents a bounded parser/scanner guard rather than malformed document content.

#
ConversionResult

source

pub(all) struct ConversionResult {
  value : String
  messages : Array[Message]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Converted value together with accumulated diagnostics.

#
ConversionResult::combine

source

fn ConversionResult::combine(self : ConversionResult, other : ConversionResult) -> ConversionResult

Combines two conversion results.

#
ConversionResult::equal

source

#deprecated("implicit trait-method promotion is being removed; call via the trait")
fn ConversionResult::equal(ConversionResult, ConversionResult) -> Bool

#
ConversionResult::flat_map

source

fn ConversionResult::flat_map(self : ConversionResult, f : (String) -> ConversionResult raise?) -> ConversionResult raise?

Flat-maps the converted value while preserving diagnostics.

#
ConversionResult::map

source

fn ConversionResult::map(self : ConversionResult, f : (String) -> String raise?) -> ConversionResult raise?

Maps the converted value while preserving diagnostics.

#
ConversionResult::not_equal

source

#deprecated("implicit trait-method promotion is being removed; call via the trait")
fn ConversionResult::not_equal(x : ConversionResult, y : ConversionResult) -> Bool

#
ConversionResult::to_repr

source

#deprecated("implicit trait-method promotion is being removed; call via the trait")
fn ConversionResult::to_repr(ConversionResult) -> @moonbitlang/core/debug.Repr
Repr

#
DocxXmlResourceLimit

source

pub(all) enum DocxXmlResourceLimit {
  DocxXmlSourceUnits
  DocxXmlTokens
  DocxXmlTokenLength
  DocxXmlMaterializedCharacters
  DocxXmlNestingDepth
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A machine-readable XML work or allocation guard. Keeping this distinct from diagnostic text prevents document-controlled names and identifiers from forging resource-limit status at higher API layers.

#
DocxXmlResourceLimit::equal

source

#deprecated("implicit trait-method promotion is being removed; call via the trait")
fn DocxXmlResourceLimit::equal(DocxXmlResourceLimit, DocxXmlResourceLimit) -> Bool

#
DocxXmlResourceLimit::message

source

fn DocxXmlResourceLimit::message(self : DocxXmlResourceLimit) -> String

Stable human-readable text retained for CLI and validation diagnostics.

#
DocxXmlResourceLimit::not_equal

source

#deprecated("implicit trait-method promotion is being removed; call via the trait")
fn DocxXmlResourceLimit::not_equal(x : DocxXmlResourceLimit, y : DocxXmlResourceLimit) -> Bool

#
DocxXmlResourceLimit::to_repr

source

#deprecated("implicit trait-method promotion is being removed; call via the trait")
fn DocxXmlResourceLimit::to_repr(DocxXmlResourceLimit) -> @moonbitlang/core/debug.Repr
Repr

#
Message

source

pub(all) enum Message {
  Warning(String)
  Error(String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Diagnostic emitted while reading or converting a document.

#
Message::equal

source

#deprecated("implicit trait-method promotion is being removed; call via the trait")
fn Message::equal(Message, Message) -> Bool

#
Message::not_equal

source

#deprecated("implicit trait-method promotion is being removed; call via the trait")
fn Message::not_equal(x : Message, y : Message) -> Bool

#
Message::to_repr

source

#deprecated("implicit trait-method promotion is being removed; call via the trait")
fn Message::to_repr(Message) -> @moonbitlang/core/debug.Repr
Repr

#
combine_results

source

fn combine_results(results : Array[ConversionResult]) -> ConversionResult

Combines conversion results, preserving values and diagnostics.

#
contextual_docx_xml_resource_limit_error

source

fn contextual_docx_xml_resource_limit_error(limit : DocxXmlResourceLimit, message : String) -> DocxError

Adds trusted operation context while preserving the machine discriminator.

#
dedupe_messages

source

fn dedupe_messages(messages : Array[Message]) -> Array[Message]

Removes duplicate diagnostics while preserving order.

#
docx_xml_resource_limit_error

source

fn docx_xml_resource_limit_error(limit : DocxXmlResourceLimit) -> DocxError

Constructs a typed XML resource error with its stable default diagnostic.

#
error

source

fn error(message : String) -> Message

Creates an error diagnostic.

#
success

source

fn success(value : String) -> ConversionResult

Creates a successful conversion result with no diagnostics.

#
warning

source

fn warning(message : String) -> Message

Creates a warning diagnostic.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#DocxError

#DocxError::description

#DocxError::equal

#DocxError::not_equal

#DocxError::to_repr

#DocxError::xml_resource_limit

#ConversionResult

#ConversionResult::combine

#ConversionResult::equal

#ConversionResult::flat_map

#ConversionResult::map

#ConversionResult::not_equal

#ConversionResult::to_repr

#DocxXmlResourceLimit

#DocxXmlResourceLimit::equal

#DocxXmlResourceLimit::message

#DocxXmlResourceLimit::not_equal

#DocxXmlResourceLimit::to_repr

#Message

#Message::equal

#Message::not_equal

#Message::to_repr

#combine_results

#contextual_docx_xml_resource_limit_error

#dedupe_messages

#docx_xml_resource_limit_error

#error

#success

#warning

Source Files

#
DocxError

#
DocxError::description

#
DocxError::equal

#
DocxError::not_equal

#
DocxError::to_repr

#
DocxError::xml_resource_limit

#
ConversionResult

#
ConversionResult::combine

#
ConversionResult::equal

#
ConversionResult::flat_map

#
ConversionResult::map

#
ConversionResult::not_equal

#
ConversionResult::to_repr

#
DocxXmlResourceLimit

#
DocxXmlResourceLimit::equal

#
DocxXmlResourceLimit::message

#
DocxXmlResourceLimit::not_equal

#
DocxXmlResourceLimit::to_repr

#
Message

#
Message::equal

#
Message::not_equal

#
Message::to_repr

#
combine_results

#
contextual_docx_xml_resource_limit_error

#
dedupe_messages

#
docx_xml_resource_limit_error

#
error

#
success

#
warning