Encodable<T> class abstract interface

An object that can encode a value of type T to various data formats.

The interface can be used like this:

class UriEncodable implements Encodable<Uri> {
  const UriEncodable();

  @override
  void encode(Uri value, Encoder encoder) {
    /* ... */
  }
}

The Encodable interface can be used for any type, especially ones that cannot be modified to implement SelfEncodable instead, like core or third-party types. It can also be used to separate the encoding logic from the type definition.

Objects implementing Encodable can encode values to various data formats using the respective to<Format>(T value) extension method. A particular method is available by importing the appropriate library or package:

final Encodable<Uri> uriEncodable = const UriEncodable();
final Uri uri = ...;

// From 'package:codable/json.dart'
final String json = uriEncodable.toJson(uri);

// From 'package:codable/standard.dart'
final Object value = uriEncodable.toValue(uri);

// From imaginary 'package:x/x.dart'
final X x = uriEncodable.toX(uri);

See also:

• SelfEncodable for self-encoding objects to various data formats.
• Decodable for decoding values of some type from various data formats.
• Codable for combining both encoding and decoding of types.