merman library
Flutter and Dart FFI bindings for the merman headless Mermaid engine.
This public facade owns Dart-friendly lifecycle, error, resource, and text
measurement APIs. Its C declarations stay private and are generated from
the ABI 3 header by ffigen.
Classes
- Merman
- Discovery and one-shot facade for Flutter and standalone Dart hosts.
- MermanAsciiCapability
- ASCII rendering capability for one Mermaid diagram type.
- MermanAsciiCapabilityEvidence
- Evidence attached to an ASCII rendering capability record.
- MermanAsciiOutputPlan
- Terminal projection and viewport outcome for the ASCII operation.
- MermanCancellationErrorDetails
- Stable details attached to a cooperative operation cancellation.
- MermanDiagnosticErrorDetails
- Stable machine-readable context for a parser or renderer failure.
- MermanDiagnosticSpan
- Byte span attached to a structured parser or renderer diagnostic.
- MermanDiagramFamilyCapability
- Parser/render capability for one Mermaid diagram family.
- MermanEngine
- A reusable native engine with immutable constructor-owned services.
- MermanEngineServices
- Immutable constructor-owned services for one reusable engine.
- MermanExactResourceErrorDetails
- Lossless resource metadata for the complete unsigned 64-bit native range.
- MermanIconPack
- One immutable IconifyJSON collection supplied during engine construction.
- MermanIconPackSet
- A reusable immutable collection of icon packs.
- MermanIconRegistryErrorDetails
- Stable details attached to an icon-registry construction failure.
- MermanLintRuleCatalogEntry
- Public metadata for one lint rule exposed by the native artifact.
- MermanOperation
- One executable operation in the generated native ABI projection.
- MermanOperationControl
- Opaque native control shared with one or more synchronous operations.
- MermanOperationMetadata
- Typed schema-1 metadata returned with every native operation result.
- MermanOperationResult
- A binary-safe generic-operation result returned by the ABI 3 table.
- MermanOutputPlan
- Open output-plan vocabulary carried by operation metadata.
- MermanPdfFilterImagesOutputPlan
- Effective rasterization budget for SVG filter groups embedded in a PDF.
- MermanPresentationAspect
- One independently applicable part of a presentation profile.
- MermanPresentationAspectApplicability
- Scope in which a presentation aspect applies.
- MermanPresentationCatalog
- Artifact-owned presentation theme and profile metadata.
- MermanPresentationProfile
- One Merman-owned presentation profile advertised by the artifact.
- MermanPresentationThemePreset
- One built-in host/editor presentation theme advertised by the artifact.
- MermanRasterOutputPlan
- Effective raster dimensions after resource-limit planning.
- MermanResourceErrorDetails
- Stable resource metadata attached to a native resource-limit failure.
- MermanResourceLimitDescriptor
- A validated runtime catalog returned by the native ABI 3 table.
- MermanResourceLimitId
- MermanResourceOptions
- MermanResourceOptionsBuilder
- MermanResourceProfileDescriptor
- MermanRuntimeCatalog
- MermanRuntimeConstructorResourceLimit
- One fixed constructor-time resource limit for a native service.
- MermanRuntimeConstructorServiceContract
- Runtime contract for one constructor-owned service.
- MermanRuntimeEmbeddedImageContract
- Embedded-image behavior used by a native binary-output backend.
- MermanRuntimeEmbeddedImageLimits
- Resource limits applied while a native backend decodes embedded images.
- MermanRuntimeOutputContract
- Runtime behavior contract for one output exposed by the loaded artifact.
- MermanRuntimePayloadSchema
- One independently versioned binding payload advertised by the loaded artifact.
- MermanRuntimeSystemFontContract
- System-font behavior used by a native binary-output backend.
- MermanTextMeasureRequest
- A Dart view of one synchronous text-measurement request.
- MermanTextMeasureResult
- A validated handled text-measurement result.
- MermanUnknownOutputPlan
- A future output plan not understood by this SDK version.
- MermanValidationResult
- A concise decoded validation response.
Enums
- MermanErrorKind
- Stable machine-readable classification for a binding failure.
- MermanResourceOverrideId
- MermanResourceProfile
- MermanTextDirection
- MermanTextMeasurementOperation
- MermanTextMeasurementPhase
- MermanTextMeasurementResultKind
- MermanTextWhiteSpace
- MermanTextWrapMode
Constants
- mermanPackageVersion → const String
Functions
-
openMermanLibraryFromPath(
String path) → DynamicLibrary -
Opens a native
merman-ffilibrary atpath.
Typedefs
- MermanTextMeasurer = MermanTextMeasureResult? Function(MermanTextMeasureRequest request)
- Host callback invoked synchronously while native rendering measures text.
Exceptions / Errors
- MermanBusyException
- The engine has an active operation and cannot admit or close immediately.
- MermanCancelledException
- A synchronous operation stopped at a cooperative cancellation checkpoint.
- MermanException
- Error returned by the native ABI or by a local contract validation failure.
- MermanMissingCapabilityException
- A valid request requires a capability absent from the native artifact.
- MermanReentrantCallException
- The same engine was re-entered or closed while its callback was active.
- MermanUnknownOperationException
- The requested operation ID or native code is not defined by the ABI.
- MermanUnsupportedOperationException
- A typed native failure indicating an unknown or unavailable operation.