Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Shiwei Zhang <[email protected]>
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,83 +1,83 @@ | ||
| /* | ||
| Copyright The ORAS Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package progress_test | ||
|
|
||
| import ( | ||
| "crypto/rand" | ||
| "fmt" | ||
| "io" | ||
|
|
||
| "oras.land/oras-go/v2/progress" | ||
| ) | ||
|
|
||
| // ExampleTrackReader demonstrates how to track the transmission progress of a | ||
| // reader. | ||
| func ExampleTrackReader() { | ||
| // Set up a progress tracker. | ||
| total := int64(11) | ||
| tracker := progress.TrackerFunc(func(status progress.Status, err error) error { | ||
| if err != nil { | ||
| fmt.Printf("Error: %v\n", err) | ||
| return nil | ||
| } | ||
| switch status.State { | ||
| case progress.StateInitialized: | ||
| fmt.Println("Start reading content") | ||
| case progress.StateTransmitting: | ||
| fmt.Printf("Progress: %d/%d bytes\n", status.Offset, total) | ||
| case progress.StateTransmitted: | ||
| fmt.Println("Finish reading content") | ||
| default: | ||
| // Ignore other states. | ||
| } | ||
| return nil | ||
| }) | ||
| // Close takes no effect for TrackerFunc but should be called for general | ||
| // Tracker implementations. | ||
| defer tracker.Close() | ||
|
|
||
| // Wrap a reader of a random content generator with the progress tracker. | ||
| r := io.LimitReader(rand.Reader, total) | ||
| rc := progress.TrackReader(tracker, r) | ||
|
|
||
| // Start tracking the transmission. | ||
| if err := progress.Start(tracker); err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| // Read from the random content generator and discard the content, while | ||
| // tracking the progress. | ||
| // Note: io.Discard is wrapped with a io.MultiWriter for dropping | ||
| // the io.ReadFrom interface for demonstration purposes. | ||
| buf := make([]byte, 3) | ||
| w := io.MultiWriter(io.Discard) | ||
| if _, err := io.CopyBuffer(w, rc, buf); err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| // Finish tracking the transmission. | ||
| if err := progress.Done(tracker); err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| // Output: | ||
| // Start reading content | ||
| // Progress: 3/11 bytes | ||
| // Progress: 6/11 bytes | ||
| // Progress: 9/11 bytes | ||
| // Progress: 11/11 bytes | ||
| // Finish reading content | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,48 +1,48 @@ | ||
| /* | ||
| Copyright The ORAS Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| // Package progress tracks the status of descriptors being processed. | ||
| package progress | ||
|
|
||
| import ( | ||
| "io" | ||
|
|
||
| ocispec "github.com/opencontainers/image-spec/specs-go/v1" | ||
| ) | ||
|
|
||
| // Manager tracks the progress of multiple descriptors. | ||
| type Manager interface { | ||
| io.Closer | ||
|
|
||
| // Track starts tracking the progress of a descriptor. | ||
| Track(desc ocispec.Descriptor) (Tracker, error) | ||
| } | ||
|
|
||
| // ManagerFunc is an adapter to allow the use of ordinary functions as Managers. | ||
| // If f is a function with the appropriate signature, ManagerFunc(f) is a | ||
| // [Manager] that calls f. | ||
| type ManagerFunc func(desc ocispec.Descriptor, status Status, err error) error | ||
|
|
||
| // Close closes the manager. | ||
| func (f ManagerFunc) Close() error { | ||
| return nil | ||
| } | ||
|
|
||
| // Track starts tracking the progress of a descriptor. | ||
| func (f ManagerFunc) Track(desc ocispec.Descriptor) (Tracker, error) { | ||
| return TrackerFunc(func(status Status, err error) error { | ||
| return f(desc, status, err) | ||
| }), nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,40 @@ | ||
| /* | ||
| Copyright The ORAS Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package progress | ||
|
|
||
| // State represents the state of a descriptor. | ||
| type State int | ||
|
|
||
| // Registered states. | ||
| const ( | ||
| StateUnknown State = iota // unknown state | ||
| StateInitialized // progress initialized | ||
| StateTransmitting // transmitting content | ||
| StateTransmitted // content transmitted | ||
| StateExists // content exists | ||
| StateSkipped // content skipped | ||
| StateMounted // content mounted | ||
| ) | ||
|
|
||
| // Status represents the status of a descriptor. | ||
| type Status struct { | ||
| // State represents the state of the descriptor. | ||
| State State | ||
|
|
||
| // Offset represents the current offset of the descriptor. | ||
| // Offset is discarded if set to a negative value. | ||
| Offset int64 | ||
| } |
Oops, something went wrong.