TqdmWrapper

Full name Microsoft.VisualBasic.ApplicationServices.Terminal.ProgressBar.Tqdm.TqdmWrapper Assembly Microsoft.VisualBasic.Runtime Members 12

The Tqdm class offers utility functions to wrap collections and enumerables with a ProgressBar, providing a simple and effective way to track and display progress in console applications for various iterative operations.

00 Remarks

https://github.com/shaltielshmid/TqdmSharp

01 Syntax

Microsoft.VisualBasic.ApplicationServices.Terminal.ProgressBar.Tqdm.TqdmWrapper

02 Methods

Name	Overloads	Summary
Wrap	4	Wraps a collection with a progress bar for iteration and provides the progress bar instance for external control (like custom labels).
StreamReader	1
Range	1	Generates a sequence of integral numbers within a specified range.
Wrap	4
WrapIterator	1
WrapStreamReader	1

03 Members

method Wrap overload 2 #

Wrap``1(ICollection(Of ``0), Int32, Int32, Boolean, Boolean)

Wraps a collection with a progress bar for iteration, providing visual feedback on progress.

Parameters

Name	Type	Description
`collection`	ICollection(Of ``0)	The collection to iterate over.
`width`	`Int32`	The width of the progress bar.
`printsPerSecond`	`Int32`	The update frequency of the progress bar.
`useColor`	`Boolean`	Indicates whether to use colored output for the progress bar.

Returns

An enumerable that iterates over the collection with progress tracking.

method Wrap overload 4 #

Wrap``1(IEnumerable(Of ``0), Int32, Int32, Int32, Boolean, Boolean)

Wraps an enumerable with a specified total count with a progress bar for iteration, providing visual feedback on progress.

Parameters

Name	Type	Description
`enumerable`	IEnumerable(Of ``0)	The enumerable to iterate over.
`total`	`Int32`	The total number of expected items in the enumerable.
`width`	`Int32`	The width of the progress bar.
`printsPerSecond`	`Int32`	The update frequency of the progress bar.
`useColor`	`Boolean`	Indicates whether to use colored output for the progress bar.

Returns

An enumerable that iterates over the collection with progress tracking.

method Wrap #

Wrap``1(ICollection(Of ``0), ProgressBar, Int32, Int32, Boolean, Boolean)

Wraps a collection with a progress bar for iteration and provides the progress bar instance for external control (like custom labels).

Parameters

Name	Type	Description
`collection`	ICollection(Of ``0)	The collection to iterate over.
`bar`	ProgressBar	The progress bar instance used for tracking.
`width`	`Int32`	The width of the progress bar.
`printsPerSecond`	`Int32`	The update frequency of the progress bar.
`useColor`	`Boolean`	Indicates whether to use colored output for the progress bar.

Returns

An enumerable that iterates over the collection with progress tracking.

method Wrap overload 3 #

Wrap``1(IEnumerable(Of ``0), Int32, ProgressBar, Int32, Int32, Boolean, Boolean)

Wraps an enumerable with a specified total count with a progress bar for iteration and provides the progress bar instance for external control (like custom labels).

Parameters

Name	Type	Description
`enumerable`	IEnumerable(Of ``0)	The enumerable to iterate over.
`total`	`Int32`	The total number of items in the enumerable.
`bar`	ProgressBar	The progress bar instance used for tracking.
`width`	`Int32`	The width of the progress bar.
`printsPerSecond`	`Int32`	The update frequency of the progress bar.
`useColor`	`Boolean`	Indicates whether to use colored output for the progress bar.

Returns

An enumerable that iterates over the collection with progress tracking.

method StreamReader #

StreamReader(StreamReader)

Parameters

Name	Type	Description
`str`	`StreamReader`	-

Returns

this function returns a string line populator function, each time call this result function pointer will populate a new line and move to next line. if this function returns nothing, that it means read the end of the stream.

method Range #

Range(Int32, Int32, ProgressBar, Int32, Int32, Boolean, Boolean)

Generates a sequence of integral numbers within a specified range.

Parameters

Name	Type	Description
`start`	`Int32`	The value of the first integer in the sequence.
`count`	`Int32`	The number of sequential integers to generate.
`bar`	ProgressBar	-
`width`	`Int32`	-
`printsPerSecond`	`Int32`	-
`useColor`	`Boolean`	-

Returns

a range of sequential integral numbers.

method Wrap #

Wrap(ICollection(Of T), Int32, Int32, Boolean, Boolean)

method Wrap overload 3 #

Wrap(IEnumerable(Of T), Int32, Int32, Int32, Boolean, Boolean)

method WrapIterator #

WrapIterator(IEnumerable(Of T), ProgressBar, Int32, Int32, Boolean, Boolean)

method Wrap overload 2 #

Wrap(IEnumerable(Of T), Int32, ProgressBar, Int32, Int32, Boolean, Boolean)

method Wrap overload 4 #

Wrap(Int32, Int32, Int32, Boolean)

method WrapStreamReader #

WrapStreamReader(Int64, TqdmWrapper+RequestStreamProgressLocation(Of T))