PIso<S, T, A, B>

class PIso<S, T, A, B> extends PLens<S, T, A, B>

An optic representing a lossless, reversible conversion between types S and A.

A PIso is both a PLens and a PPrism — it can always extract A from S and always construct T from B. It supports polymorphic updates where the types may change.

Inheritance

Object → PSetter<S, T, A, B> → POptional<S, T, A, B> → PLens<S, T, A, B> → PIso<S, T, A, B>

Constructors

PIso()

PIso(A Function(S) get, T Function(B) reverseGet)

Creates a PIso from a forward get and a backward reverseGet.

Implementation

PIso(Function1<S, A> get, this.reverseGet) : super(get, (b) => (_) => reverseGet(b));

Properties

get final inherited

final A Function(S) get

Extracts the focus A from S. Unlike POptional.getOrModify, this always succeeds.

Inherited from PLens.

Implementation

final Function1<S, A> get;

getOrModify final inherited

final Either<T, A> Function(S) getOrModify

Attempts to extract the focus A from S. Returns Right with the value on success, or Left with the unmodified structure T if the focus is absent.

Inherited from POptional.

Implementation

final Function1<S, Either<T, A>> getOrModify;

hashCode no setter inherited

int get hashCode

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;

modify final inherited

final T Function(S) Function(B Function(A)) modify

Applies a transformation f to every focus A within S, producing a new structure T.

Inherited from PSetter.

Implementation

final Function2C<Function1<A, B>, S, T> modify;

reverseGet final

final T Function(B) reverseGet

Constructs a T from a B value (the reverse direction).

Implementation

final Function1<B, T> reverseGet;

runtimeType no setter inherited

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation

external Type get runtimeType;

Methods

andThen()

PIso<S, T, C, D> andThen<C, D>(PIso<A, B, C, D> other)

Composes this iso with other, producing an iso that converts from S through A into C.

Implementation

PIso<S, T, C, D> andThen<C, D>(PIso<A, B, C, D> other) => PIso<S, T, C, D>(
  (s) => other.get(get(s)),
  (d) => reverseGet(other.reverseGet(d)),
);

andThenG() inherited

Getter<S, C> andThenG<C>(Getter<A, C> other)

Composes this lens with a Getter, producing a Getter that focuses through A into C.

Inherited from PLens.

Implementation

Getter<S, C> andThenG<C>(Getter<A, C> other) => Getter((S s) => other.get(get(s)));

andThenL() inherited

PLens<S, T, C, D> andThenL<C, D>(PLens<A, B, C, D> other)

Composes this lens with other, producing a lens that focuses through A into C.

Inherited from PLens.

Implementation

PLens<S, T, C, D> andThenL<C, D>(PLens<A, B, C, D> other) => PLens<S, T, C, D>(
  (s) => other.get(get(s)),
  (d) => modify(other.replace(d)),
);

andThenO() inherited

POptional<S, T, C, D> andThenO<C, D>(POptional<A, B, C, D> other)

Composes this optional with other, producing an optional that focuses through A into C.

Inherited from POptional.

Implementation

POptional<S, T, C, D> andThenO<C, D>(POptional<A, B, C, D> other) => POptional<S, T, C, D>(
  (s) =>
      getOrModify(s).flatMap((a) => other.getOrModify(a).bimap((b) => replace(b)(s), (c) => c)),
  (d) => modify(other.replace(d)),
);

andThenS() inherited

PSetter<S, T, C, D> andThenS<C, D>(PSetter<A, B, C, D> other)

Composes this setter with other, producing a setter that focuses through A into C.

Inherited from PSetter.

Implementation

PSetter<S, T, C, D> andThenS<C, D>(PSetter<A, B, C, D> other) {
  return PSetter<S, T, C, D>((f) => modify(other.modify(f)));
}

asSetter()

PSetter<S, T, A, B> asSetter()

Views this PIso as a PSetter.

Implementation

PSetter<S, T, A, B> asSetter() => this;

exists() inherited

bool Function(S) exists(bool Function(A) p)

Returns a predicate on S that is true when at least one focus satisfies p.

Inherited from Fold.

Implementation

Function1<S, bool> exists(Function1<A, bool> p) => (s) => find(p)(s).isDefined;

find() inherited

Option<A> Function(S) find(bool Function(A) p)

Returns a function that finds the first focus in S satisfying p, or None if no match exists.

Inherited from Fold.

Implementation

Function1<S, Option<A>> find(Function1<A, bool> p);

getOption() inherited

Option<A> getOption(S s)

Extracts the focus as an Option, returning None if absent.

Inherited from POptional.

Implementation

Option<A> getOption(S s) => getOrModify(s).toOption();

modifyOption() inherited

Option<T> Function(S) modifyOption(B Function(A) f)

Like modify, but returns None if the focus is absent instead of returning the structure unchanged.

Inherited from POptional.

Implementation

Function1<S, Option<T>> modifyOption(Function1<A, B> f) =>
    (s) => getOption(s).map((a) => replace(f(a))(s));

noSuchMethod() inherited

dynamic noSuchMethod(Invocation invocation)

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);

replace() inherited

T Function(S) replace(B b)

Replaces every focus with the constant value b.

Inherited from PSetter.

Implementation

Function1<S, T> replace(B b) => modify((_) => b);

replaceOption() inherited

Option<T> Function(S) replaceOption(B b)

Like replace, but returns None if the focus is absent.

Inherited from POptional.

Implementation

Function1<S, Option<T>> replaceOption(B b) => modifyOption((_) => b);

reverse()

PIso<B, A, T, S> reverse()

Returns the reverse isomorphism, swapping the forward and backward directions.

Implementation

PIso<B, A, T, S> reverse() => PIso<B, A, T, S>(reverseGet, get);

toString() inherited

String toString()

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();

Operators

operator ==() inherited

bool operator ==(Object other)

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);