branch

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 20, 2019 License: CC0-1.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewShoot

func NewShoot(parentCtx context.Context, host, rootTag string, root []byte, pathState *[48]byte, tr http.RoundTripper) (io.ReadCloser, error)

NewShoot returns an io.Reader which reads from the content of a shoot, following the specifications of draft-shrub.fr-shrubbery available at https://github.com/shrub-fr/spec-shrub/blob/master/shrubbery.md#shootstreaming-algorithm

'host' is the hostname from where the application/branch file must be retrieved using the CORS protocol without credentials, with an opaque origin and with the mapping of .Well-Known URLs defined at https://github.com/shrub-fr/spec-shrub/blob/master/shrubbery.md#the-well-known-uris-suffix-shrubbery

'rootTag' is the base32 encoding of the tag of the root of the shrub containing the shoot.

'root' is the base32 decoding of rootTag.

'pathState' is the state of a Gimli Sponge which has absorbed the path of the shoot.

'tr' is a transport to use to retrieve the application/branch file which contains the shoot.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL