Function GetDocStorageReadBucket

private/bufpkg/bufmodule/module_read_bucket.go:231–246

GetDocStorageReadBucket gets a storage.ReadBucket that just contains the documentation file(s). This is needed for i.e. using RootToExcludes in NewWorkspaceForBucket.

(ctx context.Context, bucket storage.ReadBucket)

//
// This is needed for i.e. using RootToExcludes in NewWorkspaceForBucket.
func GetDocStorageReadBucket(ctx context.Context, bucket storage.ReadBucket) (storage.ReadBucket, error) {
	// Store the documentation file in a new memory bucket for performance reasons.
	docFilePath := getDocFilePathForStorageReadBucket(ctx, bucket)
	if docFilePath == "" {
		return storage.MultiReadBucket(), nil // nop bucket
	}
	content, err := storage.ReadPath(ctx, bucket, docFilePath)
	if err != nil {
		return nil, err
	}
	return storagemem.NewReadBucket(
		map[string][]byte{
			docFilePath: content,
		},
	)
}

// GetLicenseStorageReadBucket gets a storage.ReadBucket that just contains the license file(s).
//