package rc4

Import Path
	crypto/rc4 (on go.dev)

Dependency Relation
	imports 2 packages, and imported by one package

Involved Source Files

	  d rc4.go
		Package rc4 implements RC4 encryption, as defined in Bruce Schneier's
		Applied Cryptography.
		
		RC4 is cryptographically broken and should not be used for secure
		applications.
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Cipher (struct)
		A Cipher is an instance of RC4 using a particular key.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			i uint8
			j uint8
			s [256]uint32
		Methods (total 2, both are exported)
			(*Cipher) Reset()
				Reset zeros the key data and makes the Cipher unusable.
				
				Deprecated: Reset can't guarantee that the key will be entirely removed from
				the process's memory.

			(*Cipher) XORKeyStream(dst, src []byte)
				XORKeyStream sets dst to the result of XORing src with the key stream.
				Dst and src must overlap entirely or not at all.

		Implements (at least one exported)
			*Cipher : crypto/cipher.Stream
		As Outputs Of (at least one exported)
			func NewCipher(key []byte) (*Cipher, error)

	 type KeySizeError int (basic type)

		Methods (only one, which is exported)
			( KeySizeError) Error() string
		Implements (at least one exported)
			 KeySizeError : error


Package-Level Functions (only one, which is exported)

	 func NewCipher(key []byte) (*Cipher, error)
		NewCipher creates and returns a new Cipher. The key argument should be the
		RC4 key, at least 1 byte and at most 256 bytes.

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.