longhuanlin/multipart-stream/form

README
U
AuditSummary
U
AuditedSink
U
ChunkSourceAdapter
U
DecodedField
U
FieldCollector
U
FieldCollectorLimits
U
FormError
U
FormField
U
HeaderField
U
LimitKind
U
Limits
U
MeasuredSink
U
MediaType
U
MixedError
U
MixedEvent
U
MixedLimits
U
MixedPart
U
MixedStream
U
MultipartDiagnostic
U
MultipartError
U
MultipartEvent
U
MultipartParser
U
MultipartPlan
U
MultipartWriter
U
Parameter
U
ParserPhase
U
ParserStats
U
PartDigest
U
PartMeta
U
PartSinkAdapter
U
PlannedEmitter
U
PlannedPart
U
SinkMetrics
U
UploadError
U
UploadPart
U
UploadPartKind
U
UploadPipeline
U
UploadPolicy
U
UploadProgress
U
UploadReceipt
U
UploadSink
V
body_contains_boundary
V
boundary_from_entropy
V
crc32_finish
V
crc32_initial
V
crc32_update
V
decode_extended_filename
V
default_field_collector_limits
V
default_limits
V
default_mixed_limits
V
default_upload_policy
V
drive_events
V
expand_mixed
V
format_content_type
V
format_part_headers
V
parse_content_type
V
parse_from_source
V
parse_part_headers
V
plan
V
redact_error
V
validate_boundary

longhuanlin/multipart-stream/form does not have a README file

FormError

pub(all) suberror FormError {
  InvalidCollectorLimits(reason~ : String)
  UnexpectedEvent(reason~ : String)
  FilePartRejected(part_index~ : Int)
  FieldLimitExceeded(limit~ : Int64, observed~ : Int64)
  FieldCountExceeded(limit~ : Int, observed~ : Int)
  InvalidTextEncoding(field_name~ : String, charset~ : String)
  SinkFailed(reason~ : String)
  SourceFailed(reason~ : String)
  Protocol(error~ : @longhuanlin/multipart-stream/model.MultipartError
MultipartError)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Failures at the collector and transport-adapter boundary.

ChunkSourceAdapter

source

pub struct ChunkSourceAdapter {
  next_chunk : () -> Result[Bytes?, FormError]
}

A transport-neutral source of already-owned body chunks. Native async and framework adapters can wrap their own readers behind this callback without changing the all-target core parser.

ChunkSourceAdapter::new

source

fn ChunkSourceAdapter::new(next_chunk : () -> Result[Bytes?, FormError]) -> ChunkSourceAdapter

DecodedField

source

pub(all) struct DecodedField {
  name : String
  value : String
  content_type : String?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A decoded text field. Decoding is explicit so binary field consumers can continue using FormField.value without an implicit UTF-8 conversion.

FieldCollector

source

pub struct FieldCollector {
  limits : FieldCollectorLimits
  fields : Array[FormField]
  active_meta : @longhuanlin/multipart-stream/model.PartMeta
PartMeta?
  body : @moonbitlang/core/buffer.Buffer
Buffer
  total_field_bytes : Int64
  message_ended : Bool
}

FieldCollector::consume

source

fn FieldCollector::consume(self : FieldCollector, events : Array[@longhuanlin/multipart-stream/model.MultipartEvent
MultipartEvent]) -> Unit raise FormError

Consume parser events without buffering file parts.

FieldCollector::decoded_fields

source

fn FieldCollector::decoded_fields(self : FieldCollector, default_charset? : String) -> Array[DecodedField] raise FormError

Decode collected fields using an explicit default or a _charset_ field. Only UTF-8 and US-ASCII are accepted by the strict decoding policy.

FieldCollector::finish

source

fn FieldCollector::finish(self : FieldCollector) -> Array[FormField] raise FormError

Return an owned snapshot after the parser has emitted MessageEnd.

FieldCollector::new

source

fn FieldCollector::new(limits : FieldCollectorLimits) -> FieldCollector raise FormError

FieldCollectorLimits

source

pub(all) struct FieldCollectorLimits {
  max_fields : Int
  max_field_bytes : Int64
  max_total_field_bytes : Int64
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Limits for in-memory form fields. File bodies are never accepted by the collector; route them through PartSinkAdapter instead.

FormField

source

pub(all) struct FormField {
  meta : @longhuanlin/multipart-stream/model.PartMeta
PartMeta
  value : Bytes
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A completed small text or binary form field.

PartSinkAdapter

source

pub struct PartSinkAdapter {
  on_begin : (@longhuanlin/multipart-stream/model.PartMeta
PartMeta) -> Result[Unit, FormError]
  on_data : (Bytes) -> Result[Unit, FormError]
  on_end : (Int) -> Result[Unit, FormError]
  on_message_end : () -> Result[Unit, FormError]
}

Callback-based file/part sink. The callbacks receive parser-owned event data immediately; applications can write file bytes without using the in-memory FieldCollector.

PartSinkAdapter::new

source

fn PartSinkAdapter::new(on_begin : (@longhuanlin/multipart-stream/model.PartMeta
PartMeta) -> Result[Unit, FormError], on_data : (Bytes) -> Result[Unit, FormError], on_end : (Int) -> Result[Unit, FormError], on_message_end : () -> Result[Unit, FormError]) -> PartSinkAdapter

default_field_collector_limits

source

fn default_field_collector_limits() -> FieldCollectorLimits

drive_events

source

fn drive_events(events : Array[@longhuanlin/multipart-stream/model.MultipartEvent
MultipartEvent], sink : PartSinkAdapter) -> Unit raise FormError

Deliver events to a caller-supplied sink in protocol order.

parse_from_source

source

fn parse_from_source(source : ChunkSourceAdapter, parser : @longhuanlin/multipart-stream/parser.MultipartParser
MultipartParser) -> Array[@longhuanlin/multipart-stream/model.MultipartEvent
MultipartEvent] raise FormError