RillEncoder<A>

classRillEncoder<A>

A streaming binary encoder that applies an Encoder to each element of a Rill, emitting BitVector values.

RillEncoder is built by composing static factories and combinators before being run via toPipe, toPipeByte, or encode. Combinators like or and repeat allow building stateful, protocol-aware encoders.

final encoder = RillEncoder.many(Codecs.int32);
final bits = Rill.emits([1, 2, 3]).through(encoder.toPipe);

Properties

hashCode no setter inherited

intgethashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

Implementation

external int get hashCode;

runtimeType no setter inherited

TypegetruntimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation

external Type get runtimeType;

toPipe no setter

Rill<BitVector>Function(Rill<A>)gettoPipe

Exposes this encoder as a Pipe from values to BitVector chunks.

Implementation

Pipe<A, BitVector> get toPipe => (rill) => encode(rill);

toPipeByte no setter

Rill<int>Function(Rill<A>)gettoPipeByte

Exposes this encoder as a Pipe from values to raw bytes.

Implementation

Pipe<A, int> get toPipeByte =>
    (rill) => encode(rill).flatMap((bits) => Rill.chunk(Chunk.byteVector(bits.bytes)));

Methods

append()

RillEncoder<A>append(RillEncoder<A>Function()that)

Sequences this encoder followed by that on the remaining input.

Implementation

RillEncoder<A> append(Function0<RillEncoder<A>> that) => RillEncoder._(
  (r) => _step(r).map((nextOpt) => nextOpt.mapN((s, next) => (s, next.or(that())))),
);

encode()

Rill<BitVector>encode(Rill<A>rill)

Runs this encoder on rill, returning a stream of BitVector values.

Implementation

Rill<BitVector> encode(Rill<A> rill) => _apply(rill).voided.rillNoScope;

noSuchMethod() inherited

dynamicnoSuchMethod(Invocationinvocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

or()

RillEncoder<A>or(RillEncoder<A>other)

Falls back to other if this encoder produces no output for an element.

Implementation

RillEncoder<A> or(RillEncoder<A> other) {
  return RillEncoder._((r) {
    return _step(r).flatMap((nextOpt) {
      return nextOpt.fold(
        () => other._step(r),
        (x) => Pull.pure(Some(x)),
      );
    });
  });
}

repeat()

RillEncoder<A>repeat()

Repeats this encoder until the input stream is exhausted.

Implementation

RillEncoder<A> repeat() => append(repeat);

toString() inherited

StringtoString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

Implementation

external String toString();

xmap()

RillEncoder<B>xmap<B>(BFunction(A)f,AFunction(B)g)

Adapts this encoder to work on type B by mapping input values with g before encoding and output values with f after decoding.

Implementation

RillEncoder<B> xmap<B>(Function1<A, B> f, Function1<B, A> g) => RillEncoder._(
  (r) => _step(r.map(g)).map((nextOpt) => nextOpt.mapN((s1, e1) => (s1.map(f), e1.xmap(f, g)))),
);

Operators

operator ==() inherited

booloperator ==(Objectother)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

Implementation

external bool operator ==(Object other);

Static Methods

emit()

RillEncoder<A>emit<A>(BitVectorbits)

Creates an encoder that emits bits without consuming any stream element.

Implementation

static RillEncoder<A> emit<A>(BitVector bits) => RillEncoder._(
  (r) => Pull.output1(bits).append(() => Pull.pure(Some((r, RillEncoder.empty())))),
);

empty()

RillEncoder<A>empty<A>()

Creates an encoder that terminates immediately without consuming any input.

Implementation

static RillEncoder<A> empty<A>() => RillEncoder._((r) => Pull.pure(const None()));

many()

RillEncoder<A>many<A>(Encoder<A>encoder)

Repeatedly encodes elements using encoder, failing on the first error.

Implementation

static RillEncoder<A> many<A>(Encoder<A> encoder) => RillEncoder.once(encoder).repeat();

once()

RillEncoder<A>once<A>(Encoder<A>encoder)

Encodes a single element using encoder, failing if encoding fails.

Implementation

static RillEncoder<A> once<A>(Encoder<A> encoder) => RillEncoder._((r) {
  return r.pull.uncons1.flatMap((hdtl) {
    return hdtl.foldN(
      () => Pull.pure(const None()),
      (hd, tl) => encoder
          .encode(hd)
          .fold((err) => Pull.raiseError(err), (bits) => Pull.output1(bits))
          .append(() => Pull.pure(Some((tl, RillEncoder.empty())))),
    );
  });
});

raiseError()

RillEncoder<A>raiseError<A>(Objectreason, [StackTrace?stackTrace])

Creates an encoder that immediately raises reason as an error.

Implementation

static RillEncoder<A> raiseError<A>(Object reason, [StackTrace? stackTrace]) =>
    RillEncoder._((r) => Pull.raiseError(reason, stackTrace));

tryMany()

RillEncoder<A>tryMany<A>(Encoder<A>encoder)

Like many but stops quietly on the first encoding failure.

Implementation

static RillEncoder<A> tryMany<A>(Encoder<A> encoder) => tryOnce(encoder).repeat();

tryOnce()

RillEncoder<A>tryOnce<A>(Encoder<A>encoder)

Like once but leaves the element in the stream when encoding fails instead of raising an error.

Implementation

static RillEncoder<A> tryOnce<A>(Encoder<A> encoder) => RillEncoder._((r) {
  return r.pull.uncons1.flatMap((hdtl) {
    return hdtl.foldN(
      () => Pull.pure(const None()),
      (hd, tl) => encoder
          .encode(hd)
          .fold(
            (_) => Pull.pure(Some((tl.cons1(hd), RillEncoder.empty()))),
            (bits) => Pull.output1(bits).append(() => Pull.pure(Some((tl, RillEncoder.empty())))),
          ),
    );
  });
});