Module sss_rs::wrapped_sharing

Abstractions and wrappers around the core implementation of sharing/reconstructing.

For in-memory or small files, share and reconstruct are suitable. For large files or byte streams, Sharer and Reconstructor are better suited since they share/reconstruct in chunks.

For implementing custom wrappers or abstractions, basic_sharing functions can be utilized if finer-tuned control is needed.

Structs

• Reconstructor
  Used to reconstruct a secret in chunks, useful for large files.
• Sharer
  Used to share in chunks, useful for large files.
• SharerBuilder
  Builder pattern for Sharer, use Sharer::builder to instantiate.

Enums

• Error
  Error for wrapped_sharing API, any error marked with (deprecated) will not be encountered if you avoid the deprecated functions.

Functions

• reconstruct
  Reconstructs a secret to a vec
• reconstruct_buffered
  Convenience method for the common use case of using BufReaders with Reconstructor to reconstrcut large secrets
• reconstruct_buffered_dyn
  Convenience method for the common use case of using BufReaders with Reconstructor to reconstrcut large secrets
• reconstruct_from_filesDeprecated
  Performs the reconstruction of the shares from files with in the given dir with the give stem
• reconstruct_from_srcsDeprecated
  Reconstructs a secret from a given list of srcs. The srcs should all read the same number of bytes. Will rewind() secrets
• reconstruct_to_bufDeprecated
  Reconstructs from given list of shares and writes it to secret
• share
  See from_secrets_compressed for more information.
• share_buffered
  Convenience method for the common use case of using a BufReader with Sharer to share large secrets.
• share_buffered_dyn
  Convenience method for the common use case of using a BufReader with Sharer to share large secrets. Takes a non-homogeneous list of outputs.
• share_from_bufDeprecated
  Creates the shares and places them into a Vec of Vecs. This wraps around share_to_writables.
• share_to_filesDeprecated
  Shares all the shares to separate files for distribution.This is a wrapper for the share_to_writables function.
• share_to_writablesDeprecated
  Shares all the shares to individual writable destinations.