Go Sync

https://pkg.go.dev/golang.org/x/sync
Admin
Go Sync provides additional concurrency primitives for Go beyond the standard library sync and...
Tokens:3,216
Snippets:41
Trust Score:9.6
Update:1 week ago
Show doc for...
Tokens:
Raw
### func (g *Group) TryGo(f func() error) bool

Source: https://pkg.go.dev/golang.org/x/sync/errgroup

TryGo calls the given function in a new goroutine only if the number of active goroutines in the group is currently below the configured limit. The return value reports whether the goroutine was started.

```APIDOC
## func (g *Group) TryGo(f func() error) bool

### Description
TryGo calls the given function in a new goroutine only if the number of active goroutines in the group is currently below the configured limit. The return value reports whether the goroutine was started.

### Signature
func (g *Group) TryGo(f func() error) bool

### Parameters
- **f** (func() error) - Required - The function to execute in a new goroutine.

### Returns
- **bool** - True if the goroutine was started, false otherwise.
```

--------------------------------

### TryAcquire

Source: https://pkg.go.dev/golang.org/x/sync/semaphore

Acquires the semaphore with a non-negative weight of n without blocking. On success, returns true. On failure, returns false and leaves the semaphore unchanged.

```APIDOC
## TryAcquire

### Description
Acquires the semaphore with a non-negative weight of n without blocking. On success, returns true. On failure, returns false and leaves the semaphore unchanged.

### Method Signature
func (s *Weighted) TryAcquire(n int64) bool

### Parameters
- **n** (int64) - Required - The non-negative weight to acquire.

### Returns
- **bool** - true if acquired, false otherwise.
```

--------------------------------

### Acquire

Source: https://pkg.go.dev/golang.org/x/sync/semaphore

Acquires the semaphore with a non-negative weight of n, blocking until resources are available or ctx is done. On success, returns nil. On failure, returns ctx.Err() and leaves the semaphore unchanged.

```APIDOC
## Acquire

### Description
Acquires the semaphore with a non-negative weight of n, blocking until resources are available or ctx is done. On success, returns nil. On failure, returns ctx.Err() and leaves the semaphore unchanged.

### Method Signature
func (s *Weighted) Acquire(ctx context.Context, n int64) error

### Parameters
- **ctx** (context.Context) - Required - The context for cancellation and deadlines.
- **n** (int64) - Required - The non-negative weight to acquire.

### Returns
- **error** - nil on success, or ctx.Err() on failure.
```

--------------------------------

### func (g *Group) Do(key string, fn func() (any, error)) (v any, err error, shared bool)

Source: https://pkg.go.dev/golang.org/x/sync/singleflight

Executes and returns the results of the given function, ensuring only one execution is in-flight for a given key at a time. Duplicate callers wait for the original to complete and receive the same results.

```APIDOC
## func (g *Group) Do(key string, fn func() (any, error)) (v any, err error, shared bool)

### Description
Do executes and returns the results of the given function, making sure that only one execution is in-flight for a given key at a time. If a duplicate comes in, the duplicate caller waits for the original to complete and receives the same results. The return value shared indicates whether v was given to multiple callers.

### Method
Do

### Signature
func (g *Group) Do(key string, fn func() (any, error)) (v any, err error, shared bool)

### Parameters
- **key** (string) - Required - The key to identify the work unit.
- **fn** (func() (any, error)) - Required - The function to execute.

### Returns
- **v** (any) - The result of the function.
- **err** (error) - The error returned by the function.
- **shared** (bool) - Indicates whether the result was shared with multiple callers.
```

--------------------------------

### func (g *Group) Go(f func() error)

Source: https://pkg.go.dev/golang.org/x/sync/errgroup

Go calls the given function in a new goroutine. It blocks until the new goroutine can be added without exceeding the configured limit. The first goroutine that returns a non-nil error will cancel the associated Context, and the error will be returned by Wait.

```APIDOC
## func (g *Group) Go(f func() error)

### Description
Go calls the given function in a new goroutine. It blocks until the new goroutine can be added without exceeding the configured limit. The first goroutine that returns a non-nil error will cancel the associated Context, and the error will be returned by Wait.

### Signature
func (g *Group) Go(f func() error)

### Parameters
- **f** (func() error) - Required - The function to execute in a new goroutine.
```

--------------------------------

### Release

Source: https://pkg.go.dev/golang.org/x/sync/semaphore

Releases the semaphore with a non-negative weight of n.

```APIDOC
## Release

### Description
Releases the semaphore with a non-negative weight of n.

### Method Signature
func (s *Weighted) Release(n int64)

### Parameters
- **n** (int64) - Required - The non-negative weight to release.
```

--------------------------------

### NewWeighted

Source: https://pkg.go.dev/golang.org/x/sync/semaphore

Creates a new weighted semaphore with the given maximum combined weight for concurrent access. Panics if n is negative.

```APIDOC
## NewWeighted

### Description
Creates a new weighted semaphore with the given maximum combined weight for concurrent access. Panics if n is negative.

### Function Signature
func NewWeighted(n int64) *Weighted

### Parameters
- **n** (int64) - Required - The maximum combined weight for concurrent access.

### Returns
- **\*Weighted** - A pointer to the newly created weighted semaphore.

### Errors
- Panics if n is negative.
```

--------------------------------

### func (g *Group) DoChan(key string, fn func() (any, error)) <-chan Result

Source: https://pkg.go.dev/golang.org/x/sync/singleflight

DoChan is like Do but returns a channel that will receive the results when they are ready. The returned channel will not be closed.

```APIDOC
## func (g *Group) DoChan(key string, fn func() (any, error)) <-chan Result

### Description
DoChan is like Do but returns a channel that will receive the results when they are ready. The returned channel will not be closed.

### Method
DoChan

### Signature
func (g *Group) DoChan(key string, fn func() (any, error)) <-chan Result

### Parameters
- **key** (string) - Required - The key to identify the work unit.
- **fn** (func() (any, error)) - Required - The function to execute.

### Returns
- **<-chan Result** - A channel that will receive the results when ready.
```

--------------------------------

### func WithContext(ctx context.Context) (*Group, context.Context)

Source: https://pkg.go.dev/golang.org/x/sync/errgroup

WithContext returns a new Group and an associated Context derived from ctx. The derived Context is canceled the first time a function passed to Go returns a non-nil error or the first time Wait returns, whichever occurs first.

```APIDOC
## func WithContext(ctx context.Context) (*Group, context.Context)

### Description
WithContext returns a new Group and an associated Context derived from ctx. The derived Context is canceled the first time a function passed to Go returns a non-nil error or the first time Wait returns, whichever occurs first.

### Signature
func WithContext(ctx context.Context) (*Group, context.Context)

### Parameters
- **ctx** (context.Context) - Required - The parent context from which the derived context is created.

### Returns
- **(*Group, context.Context)** - A new Group and its associated derived Context.
```

--------------------------------

### func (g *Group) Wait() error

Source: https://pkg.go.dev/golang.org/x/sync/errgroup

Wait blocks until all function calls from the Go method have returned, then returns the first non-nil error (if any) from them.

```APIDOC
## func (g *Group) Wait() error

### Description
Wait blocks until all function calls from the Go method have returned, then returns the first non-nil error (if any) from them.

### Signature
func (g *Group) Wait() error

### Returns
- **error** - The first non-nil error returned by any function passed to Go, or nil if all succeeded.
```

--------------------------------

### func (g *Group) SetLimit(n int)

Source: https://pkg.go.dev/golang.org/x/sync/errgroup

SetLimit limits the number of active goroutines in this group to at most n. A negative value indicates no limit. A limit of zero will prevent any new goroutines from being added. The limit must not be modified while any goroutines in the group are active.

```APIDOC
## func (g *Group) SetLimit(n int)

### Description
SetLimit limits the number of active goroutines in this group to at most n. A negative value indicates no limit. A limit of zero will prevent any new goroutines from being added. The limit must not be modified while any goroutines in the group are active.

### Signature
func (g *Group) SetLimit(n int)

### Parameters
- **n** (int) - Required - The maximum number of active goroutines. Negative means no limit.
```

--------------------------------

### func (g *Group) Forget(key string)

Source: https://pkg.go.dev/golang.org/x/sync/singleflight

Forget tells the singleflight to forget about a key. Future calls to Do for this key will call the function rather than waiting for an earlier call to complete.

```APIDOC
## func (g *Group) Forget(key string)

### Description
Forget tells the singleflight to forget about a key. Future calls to Do for this key will call the function rather than waiting for an earlier call to complete.

### Method
Forget

### Signature
func (g *Group) Forget(key string)

### Parameters
- **key** (string) - Required - The key to forget.
```
Tokens:
Raw