package credentials

Import Path
	google.golang.org/grpc/internal/credentials (on go.dev)

Dependency Relation
	imports 5 packages, and imported by one package

Involved Source Files

	   d➜ spiffe.go
		Package credentials defines APIs for parsing SPIFFE ID.

		All APIs in this package are experimental.

	      syscallconn.go
	      util.go
Package-Level Type Names (total 2, neither is exported)

	/* sort exporteds by: alphabet | popularity */
	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type syscallConn (struct)
		syscallConn keeps reference of rawConn to support syscall.Conn for channelz.
		SyscallConn() (the method in interface syscall.Conn) is explicitly
		implemented on this type,

		Interface syscall.Conn is implemented by most net.Conn implementations (e.g.
		TCPConn, UnixConn), but is not part of net.Conn interface. So wrapper conns
		that embed net.Conn don't implement syscall.Conn. (Side note: tls.Conn
		doesn't embed net.Conn, so even if syscall.Conn is part of net.Conn, it won't
		help here).

		Fields (total 2, in which 1 are exported)
			Conn net.Conn
			/* one unexported ... *//* one unexported: */
			sysConn sysConn
				sysConn is a type alias of syscall.Conn. It's necessary because the name
				`Conn` collides with `net.Conn`.

		Methods (total 9, all are exported)
			( T) Close() error
				Close closes the connection.
				Any blocked Read or Write operations will be unblocked and return errors.

			( T) LocalAddr() net.Addr
				LocalAddr returns the local network address.

			( T) Read(b []byte) (n int, err error)
				Read reads data from the connection.
				Read can be made to time out and return an error after a fixed
				time limit; see SetDeadline and SetReadDeadline.

			( T) RemoteAddr() net.Addr
				RemoteAddr returns the remote network address.

			( T) SetDeadline(t time.Time) error
				SetDeadline sets the read and write deadlines associated
				with the connection. It is equivalent to calling both
				SetReadDeadline and SetWriteDeadline.

				A deadline is an absolute time after which I/O operations
				fail instead of blocking. The deadline applies to all future
				and pending I/O, not just the immediately following call to
				Read or Write. After a deadline has been exceeded, the
				connection can be refreshed by setting a deadline in the future.

				If the deadline is exceeded a call to Read or Write or to other
				I/O methods will return an error that wraps os.ErrDeadlineExceeded.
				This can be tested using errors.Is(err, os.ErrDeadlineExceeded).
				The error's Timeout method will return true, but note that there
				are other possible errors for which the Timeout method will
				return true even if the deadline has not been exceeded.

				An idle timeout can be implemented by repeatedly extending
				the deadline after successful Read or Write calls.

				A zero value for t means I/O operations will not time out.

			( T) SetReadDeadline(t time.Time) error
				SetReadDeadline sets the deadline for future Read calls
				and any currently-blocked Read call.
				A zero value for t means Read will not time out.

			( T) SetWriteDeadline(t time.Time) error
				SetWriteDeadline sets the deadline for future Write calls
				and any currently-blocked Write call.
				Even if write times out, it may return n > 0, indicating that
				some of the data was successfully written.
				A zero value for t means Write will not time out.

			( T) SyscallConn() (syscall.RawConn, error)
				SyscallConn returns a raw network connection.

			( T) Write(b []byte) (n int, err error)
				Write writes data to the connection.
				Write can be made to time out and return an error after a fixed
				time limit; see SetDeadline and SetWriteDeadline.

		Implements (at least 12, all are exported)
			 T : github.com/go-git/go-git/v5/plumbing/protocol/packp/sideband.Progress
			 T : github.com/jbenet/go-context/io.Reader
			 T : github.com/jbenet/go-context/io.Writer
			 T : io.Closer
			 T : io.ReadCloser
			 T : io.Reader
			 T : io.ReadWriteCloser
			 T : io.ReadWriter
			 T : io.WriteCloser
			 T : io.Writer
			 T : net.Conn
			 T : syscall.Conn

	 type sysConn = syscall.Conn (interface)
Package-Level Functions (total 4, all are exported)

	 func AppendH2ToNextProtos(ps []string) []string
		AppendH2ToNextProtos appends h2 to next protos.

	 func CloneTLSConfig(cfg *tls.Config) *tls.Config
		CloneTLSConfig returns a shallow clone of the exported
		fields of cfg, ignoring the unexported sync.Once, which
		contains a mutex and must not be copied.

		If cfg is nil, a new zero tls.Config is returned.

		TODO: inline this function if possible.

	 func SPIFFEIDFromState(state tls.ConnectionState) *url.URL
		SPIFFEIDFromState parses the SPIFFE ID from State. If the SPIFFE ID format
		is invalid, return nil with warning.

	 func WrapSyscallConn(rawConn, newConn net.Conn) net.Conn
		WrapSyscallConn tries to wrap rawConn and newConn into a net.Conn that
		implements syscall.Conn. rawConn will be used to support syscall, and newConn
		will be used for read/write.

		This function returns newConn if rawConn doesn't implement syscall.Conn.


Package-Level Variables (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	  var logger grpclog.DepthLoggerV2
Package-Level Constants (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	const alpnProtoStrH2 = "h2"

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin 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.