NanoByte.Common  2.10.5
NanoByte.Common Namespace Reference

Generic utility classes, interfaces, etc. that are applicable to a wide range of different applications. More...

Namespaces

namespace  Collections
 Specialized collection types supplementing System.Collections.Generic.
 
namespace  Controls
 WinForms controls and forms designed to simplify common UI designs.
 
namespace  Dispatch
 Functionality like double dispatch and two/three-way merging.
 
namespace  Drawing
 Helpers for manipulating images.
 
namespace  Info
 Data structures providing diagnostic information about the application, the operating system, etc..
 
namespace  Native
 Utility classes that provide OS-specific helper functions.
 
namespace  Net
 Network communication.
 
namespace  Storage
 File system access and serialization.
 
namespace  Streams
 Filter streams and utility classes with helper functions for stream handling.
 
namespace  Tasks
 Task system for managing long-running tasks and reporting progress to the user.
 
namespace  Threading
 Helpers for working with threads.
 
namespace  Undo
 Undo system based on the Command pattern.
 
namespace  Values
 Data structures and helpers for Value Types.
 

Classes

class  Disposable
 Invokes a callback on Dispose. More...
 
class  EncodingUtils
 Helper methods for encoding strings, decoding byte arrays, calculating hashes, etc.. More...
 
class  ExceptionUtils
 Provides helper methods related to Exceptions. More...
 
interface  ICloneable
 Supports cloning. More...
 
interface  IHighlightColor
 An object that can be highlighted with a specific color in graphical representations. More...
 
interface  INamed
 An entity that has a unique name that can be used for identification in lists and trees. More...
 
class  Named
 Static companion for INamed. More...
 
class  Log
 Sends log messages to custom handlers or the console. Additionally writes to System.Diagnostics.Debug, an in-memory buffer and a plain text file. More...
 
class  MathUtils
 Provides math-related utility functions. More...
 
class  NotAdminException
 Like a UnauthorizedAccessException but with the additional hint that retrying the operation as an administrator would fix the problem. More...
 
class  ProcessUtils
 Provides methods for launching child processes. More...
 
class  PropertyPointer
 Wraps delegate-based access to a value as a property. More...
 
class  StagedOperation
 Common base class for operations that are first staged and then either committed or rolled back. More...
 
class  StringUtils
 Provides additional or simplified string functions. More...
 
struct  TimedLogEvent
 Structure that allows you to log timed execution blocks. More...
 
struct  UnixTime
 Represents a point in time as the number of seconds since the Unix epoch (Unix timestamp). More...
 
class  UpdateUtils
 Provides neat little code-shortcuts for updating properties. More...
 
class  AnsiCli
 Helper methods for ANSI console rendering. More...
 

Enumerations

enum class  LogSeverity { Debug , Info , Warn , Error }
 Describes how severe/important a Log entry is. More...
 

Functions

delegate void RetryAction (bool lastAttempt)
 Delegate used by ExceptionUtils.Retry<TException>. More...
 
delegate Task RetryAsyncAction (bool lastAttempt)
 Delegate used by ExceptionUtils.RetryAsync<TException>. More...
 
delegate void LogEntryEventHandler (LogSeverity severity, string message)
 Describes an event relating to an entry in the Log. More...
 

Detailed Description

Generic utility classes, interfaces, etc. that are applicable to a wide range of different applications.

Enumeration Type Documentation

◆ LogSeverity

Describes how severe/important a Log entry is.

See also
LogEntryEventHandler
Enumerator
Debug 

Information to help developers diagnose problems.

Info 

A nice-to-know piece of information.

Warn 

A warning that doesn't have to be acted upon immediately.

Error 

A critical error that should be attended to.

Function Documentation

◆ LogEntryEventHandler()

delegate void NanoByte.Common.LogEntryEventHandler ( LogSeverity  severity,
string  message 
)

Describes an event relating to an entry in the Log.

Parameters
severityThe type/severity of the entry.
messageThe message text of the entry.
See also
Log.Handler

◆ RetryAction()

delegate void NanoByte.Common.RetryAction ( bool  lastAttempt)

Delegate used by ExceptionUtils.Retry<TException>.

Parameters
lastAttemptIndicates whether this retry run is the last attempt before giving up and passing the exception through.
See also
ExceptionUtils.Retry<TException>

◆ RetryAsyncAction()

delegate Task NanoByte.Common.RetryAsyncAction ( bool  lastAttempt)

Delegate used by ExceptionUtils.RetryAsync<TException>.

Parameters
lastAttemptIndicates whether this retry run is the last attempt before giving up and passing the exception through.
See also
ExceptionUtils.Retry<TException>