createPullEx abstract method

SecretExStreamTransformer<SecretStreamCipherMessage, SecretStreamPlainMessage> createPullEx(
  1. SecureKey key, {
  2. bool requireFinalized = true,
})

Provides crypto_secretstream_xchacha20poly1305_(init_)pull.

Works just like pullEx, but instead of creating a stream, it creates a SecretExStreamTransformer with key, which can then be used to create pull decryption streams from it. In addition, you can specify requireFinalized to control if the stream needs to receive the SecretStreamMessageTag.finalPush to be closed gracefully. If enabled (the default) and the last message does not have this tag, an error will be added to the stream before it is closed.

See https://libsodium.gitbook.io/doc/secret-key_cryptography/secretstream#decryption

Implementation

SecretExStreamTransformer<SecretStreamCipherMessage, SecretStreamPlainMessage>
    createPullEx(
  SecureKey key, {
  bool requireFinalized = true,
});