longhuanlin/multipart-stream/pipeline

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/pipeline does not have a README file

UploadError

pub(all) suberror UploadError {
  InvalidPolicy(reason~ : String)
  Protocol(error~ : @longhuanlin/multipart-stream/model.MultipartError
MultipartError)
  Mixed(error~ : @longhuanlin/multipart-stream/mixed.MixedError
MixedError)
  SinkFailed(operation~ : String)
  PartTooLarge(part_index~ : Int, limit~ : Int64, observed~ : Int64)
  TotalPayloadTooLarge(limit~ : Int64, observed~ : Int64)
  PartCountExceeded(kind~ : UploadPartKind, limit~ : Int, observed~ : Int)
  UnexpectedEvent(reason~ : String)
  Aborted(reason~ : String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ActiveDigest

source

pub(all) struct ActiveDigest {
  part : UploadPart
  bytes : Int64
  state : Int64
}

AuditSummary

source

pub(all) struct AuditSummary {
  parts : Int
  payload_bytes : Int64
  combined_crc32 : Int64
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Aggregate redacted integrity data for a completed sequence of parts.

AuditedSink

source

pub struct AuditedSink {
  sink : UploadSink
  audit : UploadAudit
}

A transactional sink decorator that records checksums while forwarding all callbacks to an application-owned delegate.

AuditedSink::digests

source

fn AuditedSink::digests(self : AuditedSink) -> Array[PartDigest]

AuditedSink::new

source

fn AuditedSink::new(delegate : UploadSink) -> AuditedSink

AuditedSink::sink

source

fn AuditedSink::sink(self : AuditedSink) -> UploadSink

AuditedSink::summary

source

fn AuditedSink::summary(self : AuditedSink) -> AuditSummary raise UploadError

MeasuredSink

source

pub struct MeasuredSink {
  delegate : UploadSink
  begin_calls : Int
  data_calls : Int64
  end_calls : Int
  commit_calls : Int
  abort_calls : Int
  payload_bytes : Int64
  max_chunk_bytes : Int
}

A sink decorator that records callback volume and peak application chunk size while forwarding behavior unchanged to an application-owned sink.

MeasuredSink::metrics

source

fn MeasuredSink::metrics(self : MeasuredSink) -> SinkMetrics

MeasuredSink::new

source

fn MeasuredSink::new(delegate : UploadSink) -> MeasuredSink

MeasuredSink::sink

source

fn MeasuredSink::sink(self : MeasuredSink) -> UploadSink

PartDigest

source

pub(all) struct PartDigest {
  part : UploadPart
  bytes : Int64
  crc32 : Int64
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One completed-part integrity record. CRC-32 is intentionally exposed as a fast corruption-detection signal, not as a cryptographic digest.

SinkMetrics

source

pub(all) struct SinkMetrics {
  begin_calls : Int
  data_calls : Int64
  end_calls : Int
  commit_calls : Int
  abort_calls : Int
  payload_bytes : Int64
  max_chunk_bytes : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Redacted callback-level measurements for a host storage sink. The values make downstream buffering visible without recording field names, filenames, payload bytes, or sink-specific paths.

UploadAudit

source

pub struct UploadAudit {
  active : ActiveDigest?
  digests : Array[PartDigest]
  payload_bytes : Int64
  combined_state : Int64
}

Incremental per-part CRC-32 recorder. It retains no payload bytes and may be used directly or through AuditedSink.

UploadAudit::begin

source

fn UploadAudit::begin(self : UploadAudit, part : UploadPart) -> Unit raise UploadError

UploadAudit::data

source

fn UploadAudit::data(self : UploadAudit, bytes : Bytes) -> Unit raise UploadError

UploadAudit::digests

source

fn UploadAudit::digests(self : UploadAudit) -> Array[PartDigest]

UploadAudit::end

source

fn UploadAudit::end(self : UploadAudit, part : UploadPart) -> Unit raise UploadError

UploadAudit::new

source

fn UploadAudit::new() -> UploadAudit

UploadAudit::summary

source

fn UploadAudit::summary(self : UploadAudit) -> AuditSummary raise UploadError

UploadPart

source

pub(all) struct UploadPart {
  meta : @longhuanlin/multipart-stream/model.PartMeta
PartMeta
  kind : UploadPartKind
  depth : Int
  parent_part_index : Int?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Metadata supplied to application-owned storage callbacks.

UploadPartKind

source

pub(all) enum UploadPartKind {
  Field
  File
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

UploadPipeline

source

pub struct UploadPipeline {
  parser : @longhuanlin/multipart-stream/parser.MultipartParser
MultipartParser
  mixed : @longhuanlin/multipart-stream/mixed.MixedStream
MixedStream?
  policy : UploadPolicy
  sink : UploadSink
  active : UploadPart?
  active_bytes : Int64
  payload_bytes : Int64
  fields_started : Int
  files_started : Int
  fields_completed : Int
  files_completed : Int
  completed : Bool
  aborted : Bool
}

UploadPipeline::cancel

source

fn UploadPipeline::cancel(self : UploadPipeline, reason~ : String) -> Unit

Terminate an in-flight transaction because the host source or request lifecycle ended outside the multipart protocol. Repeated cancellation is idempotent and never calls the sink's abort callback more than once.

UploadPipeline::feed

source

fn UploadPipeline::feed(self : UploadPipeline, chunk : Bytes) -> Unit raise UploadError

Feed a network, file, or application-owned chunk into the upload pipeline.

UploadPipeline::finish

source

fn UploadPipeline::finish(self : UploadPipeline) -> UploadReceipt raise UploadError

Complete the parser and atomically commit the host application's sink.

UploadPipeline::new

source

fn UploadPipeline::new(boundary : String, sink : UploadSink, policy? : UploadPolicy) -> UploadPipeline raise UploadError

UploadPipeline::parser_stats

source

fn UploadPipeline::parser_stats(self : UploadPipeline) -> @longhuanlin/multipart-stream/model.ParserStats
ParserStats

Return parser resource statistics for host-side metrics and admission logs.

UploadPipeline::progress

source

fn UploadPipeline::progress(self : UploadPipeline) -> UploadProgress

UploadPolicy

source

pub(all) struct UploadPolicy {
  parser_limits : @longhuanlin/multipart-stream/model.Limits
Limits
  allow_legacy_mixed : Bool
  max_file_bytes : Int64
  max_field_bytes : Int64
  max_total_payload_bytes : Int64
  max_file_count : Int
  max_field_count : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Application policy for the zero-dependency upload pipeline.

UploadProgress

source

pub(all) struct UploadProgress {
  wire_bytes : Int64
  payload_bytes : Int64
  fields_completed : Int
  files_completed : Int
  active_part : UploadPart?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

UploadReceipt

source

pub(all) struct UploadReceipt {
  wire_bytes : Int64
  payload_bytes : Int64
  fields_completed : Int
  files_completed : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

UploadSink

source

pub struct UploadSink {
  on_begin : (UploadPart) -> Result[Unit, UploadError]
  on_data : (UploadPart, Bytes) -> Result[Unit, UploadError]
  on_end : (UploadPart) -> Result[Unit, UploadError]
  on_commit : (UploadReceipt) -> Result[Unit, UploadError]
  on_abort : (UploadError) -> Unit
}

Transactional callbacks owned by the host application. The pipeline never chooses paths or opens files; a sink may stream bytes to disk, object storage, a hash calculator, or an in-memory test collector.

UploadSink::new

source

fn UploadSink::new(on_begin : (UploadPart) -> Result[Unit, UploadError], on_data : (UploadPart, Bytes) -> Result[Unit, UploadError], on_end : (UploadPart) -> Result[Unit, UploadError], on_commit : (UploadReceipt) -> Result[Unit, UploadError], on_abort : (UploadError) -> Unit) -> UploadSink

crc32_finish

source

fn crc32_finish(state : Int64) -> Int64

Finalize an incremental CRC-32 state into its conventional unsigned value.

crc32_initial

source

fn crc32_initial() -> Int64

Start an incremental CRC-32 state.

crc32_update

source

fn crc32_update(state : Int64, bytes : Bytes) -> Int64

Advance a CRC-32 state with binary-safe data.

default_upload_policy

source

fn default_upload_policy() -> UploadPolicy

Source Files

Install

Download zip

Streaming multipart/form-data parser and writer for MoonBit.

multipartform-datastreaminghttpupload

longhuanlin

Apache-2.0

github.com/longhuanlin/multipart-stream

Updated 2 months ago

47 downloads

Site source Report issue Modules Skills CLI Build queue Statistics

#UploadError

#ActiveDigest

#AuditSummary

#AuditedSink

#AuditedSink::digests

#AuditedSink::new

#AuditedSink::sink

#AuditedSink::summary

#MeasuredSink

#MeasuredSink::metrics

#MeasuredSink::new

#MeasuredSink::sink

#PartDigest

#SinkMetrics

#UploadAudit

#UploadAudit::begin

#UploadAudit::data

#UploadAudit::digests

#UploadAudit::end

#UploadAudit::new

#UploadAudit::summary

#UploadPart

#UploadPartKind

#UploadPipeline

#UploadPipeline::cancel

#UploadPipeline::feed

#UploadPipeline::finish

#UploadPipeline::new

#UploadPipeline::parser_stats

#UploadPipeline::progress

#UploadPolicy

#UploadProgress

#UploadReceipt

#UploadSink

#UploadSink::new

#crc32_finish

#crc32_initial

#crc32_update

#default_upload_policy

Source Files

UploadError

ActiveDigest

AuditSummary

AuditedSink

AuditedSink::digests

AuditedSink::new

AuditedSink::sink

AuditedSink::summary

MeasuredSink

MeasuredSink::metrics

MeasuredSink::new

MeasuredSink::sink

PartDigest

SinkMetrics

UploadAudit

UploadAudit::begin

UploadAudit::data

UploadAudit::digests

UploadAudit::end

UploadAudit::new

UploadAudit::summary

UploadPart

UploadPartKind

UploadPipeline

UploadPipeline::cancel

UploadPipeline::feed

UploadPipeline::finish

UploadPipeline::new

UploadPipeline::parser_stats

UploadPipeline::progress

UploadPolicy

UploadProgress

UploadReceipt

UploadSink

UploadSink::new

crc32_finish

crc32_initial

crc32_update

default_upload_policy