package watch

Import Path
	github.com/tmc/go-iroh/watch (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 2 packages

Involved Source Files

	  d watch.go
		Package watch provides an observable value: a [Value] that can be updated and
		one or more [Observer] handles that observe its changes.
		
		It is the Go analog of iroh's n0_watcher (Watchable + Watcher). An [Observer]
		exposes the current value, a one-shot wait for the next change, and an
		iterator stream of values. The root package uses Observer for APIs such as
		Endpoint.WatchAddr.
		
		The Go API is not stable before v1 and may change in any v0 release.
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type Observer[T] (interface)

		Type Parameters:
			T: any

		Observer observes a [Value]. Multiple observers may observe the same value
		independently. It is the Go analog of iroh's n0_watcher::Watcher.

		Methods (total 3)
			( Observer[T]) Current() T
				Current returns the current value.

			( Observer[T]) Stream(ctx context.Context) iter.Seq[T]
				Stream returns an iterator that yields each new value until ctx is done.
				The current value is delivered first.

			( Observer[T]) Updated(ctx context.Context) (T, error)
				Updated blocks until the value changes after the watcher's last observed
				version, returning the new value, or ctx.Err() if the context is done.
				The first call returns the current value immediately.

		As Outputs Of (at least 5)
			func (*Value)[T].Watch() Observer[T]
			func github.com/tmc/go-iroh/internal/socket.(*RelayActor).HomeRelayStatus() Observer[*socket.RelayStatus]
			func github.com/tmc/go-iroh/internal/socket.(*RelayTransport).HomeRelayStatus() Observer[*socket.RelayStatus]
			func github.com/tmc/go-iroh/iroh.(*Endpoint).HomeRelayStatus() Observer[*iroh.RelayStatus]
			func github.com/tmc/go-iroh/iroh.(*Endpoint).WatchAddr() Observer[netaddr.EndpointAddr]

	 type Value[T] (struct)

		Type Parameters:
			T: any

		Value is an observable container holding a T. It is safe for concurrent use.
		Updates are published to all [Observer] handles created from it.
		
		The zero Value holds the zero T and is ready to use.

		Methods (total 3)
			(*Value[T]) Current() T
				Current returns the current value.

			(*Value[T]) Set(v T)
				Set updates the value and notifies all watchers if it changed.

			(*Value[T]) Watch() Observer[T]
				Watch returns an [Observer] observing this value.

		As Outputs Of (at least 2)
			func NewValue[T](v T) *Value[T]
			func NewValueFunc[T](v T, equal func(a, b T) bool) *Value[T]


Package-Level Functions (total 2)

	 func NewValue[T](v T) *Value[T]

		Type Parameters:
			T: any

		NewValue returns a Value initialized to v.

	 func NewValueFunc[T](v T, equal func(a, b T) bool) *Value[T]

		Type Parameters:
			T: any

		NewValueFunc returns a Value initialized to v. The equal function, if non-nil,
		suppresses notifications for no-op updates.

The pages are generated with Golds v0.8.4. (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 @zigo_101 (reachable from the left QR code) to get the latest news of Golds.