Class StreamUriParser

Base class for an object that allows creating a Stream from a Uri.

Inheritance

object

StreamUriParser

SimpleStreamUriParser

Implements

IStreamUriParser

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: TheXDS.MCART.Types.Base

Assembly: MCART.dll

Syntax

public abstract class StreamUriParser : IStreamUriParser

Properties

PreferFullTransfer

Gets a value that determines if the Stream produced by this object requires to be loaded completely into an in-memory read buffer.

Declaration

public virtual bool PreferFullTransfer { get; }

Property Value

Type	Description
bool

Methods

Get(Uri)

Directly opens a Stream from which to read the content of the uri.

Declaration

public static Stream? Get(Uri uri)

Parameters

Type	Name	Description
Uri	uri	Identifier of the resource to locate.

Returns

Type	Description
Stream	A Stream from which to read the content of the uri.

GetAsync(Uri)

Directly opens a Stream asynchronously from which to read the content of the uri.

Declaration

public static Task<Stream?> GetAsync(Uri uri)

Parameters

Type	Name	Description
Uri	uri	Identifier of the resource to locate.

Returns

Type	Description
Task<Stream>	A Stream from which to read the content of the uri.

GetStream(Uri)

Gets a Stream that links to the requested resource, selecting the most appropriate method to obtain that data stream.

Declaration

public Stream? GetStream(Uri uri)

Parameters

Type	Name	Description
Uri	uri	Uri to open for reading.

Returns

Type	Description
Stream	A Stream from which the resource pointed to by the Uri specified can be read.

GetStreamAsync(Uri)

Gets a Stream that links to the requested resource, selecting the most appropriate method to obtain that data stream.

Declaration

public Task<Stream?> GetStreamAsync(Uri uri)

Parameters

Type	Name	Description
Uri	uri	Uri to open for reading.

Returns

Type	Description
Task<Stream>	A Stream from which the resource pointed to by the Uri specified can be read.

Handles(Uri)

Determines if this StreamUriParser can create a Stream from the specified Uri.

Declaration

public abstract bool Handles(Uri uri)

Parameters

Type	Name	Description
Uri	uri	Uri to check.

Returns

Type	Description
bool	true if this StreamUriParser can create a Stream from the specified Uri, false otherwise.

Infer(string)

Gets the appropriate StreamUriParser to handle the specified Uri.

Declaration

public static StreamUriParser? Infer(string uri)

Parameters

Type	Name	Description
string	uri	Uri from which to create a Stream.

Returns

Type	Description
StreamUriParser	A StreamUriParser that can create a Stream from the specified Uri, or null if no StreamUriParser is capable of handling the Uri.

Infer(Uri)

Gets the appropriate StreamUriParser to handle the specified Uri.

Declaration

public static StreamUriParser? Infer(Uri uri)

Parameters

Type	Name	Description
Uri	uri	Uri from which to create a Stream.

Returns

Type	Description
StreamUriParser	A StreamUriParser that can create a Stream from the specified Uri, or null if no StreamUriParser is capable of handling the Uri.

Infer<T>(string)

Gets the appropriate StreamUriParser to handle the specified Uri.

Declaration

public static T? Infer<T>(string uri) where T : class, IStreamUriParser

Parameters

Type	Name	Description
string	uri	Uri from which to create a Stream.

Returns

Type	Description
T	A StreamUriParser that can create a Stream from the specified Uri, or null if no StreamUriParser is capable of handling the Uri.

Type Parameters

Name	Description
T	Type of specialized StreamUriParser to obtain.

Infer<T>(Uri)

Gets the appropriate StreamUriParser to handle the specified Uri.

Declaration

public static T? Infer<T>(Uri uri) where T : class, IStreamUriParser

Parameters

Type	Name	Description
Uri	uri	Uri from which to create a Stream.

Returns

Type	Description
T	A StreamUriParser that can create a Stream from the specified Uri, or null if no StreamUriParser is capable of handling the Uri.

Type Parameters

Name	Description
T	Type of specialized StreamUriParser to obtain.

Open(Uri)

Opens a Stream from the specified Uri.

Declaration

public abstract Stream? Open(Uri uri)

Parameters

Type	Name	Description
Uri	uri	Uri to open for reading.

Returns

Type	Description
Stream	A Stream from which the resource pointed to by the Uri specified can be read.

OpenFullTransfer(Uri)

Opens the Stream from the specified Uri, and loads it completely into a new intermediate Stream before returning it.

Declaration

public virtual Stream? OpenFullTransfer(Uri uri)

Parameters

Type	Name	Description
Uri	uri	Uri to open for reading.

Returns

Type	Description
Stream	A Stream from which the resource pointed to by the Uri specified can be read.

OpenFullTransferAsync(Uri)

Opens the Stream from the specified Uri, and loads it completely into a new intermediate Stream before returning it.

Declaration

public virtual Task<Stream?> OpenFullTransferAsync(Uri uri)

Parameters

Type	Name	Description
Uri	uri	Uri to open for reading.

Returns

Type	Description
Task<Stream>	A Stream from which the resource pointed to by the Uri specified can be read.

Implements

IStreamUriParser

Extension Methods

Objects.ShallowCopyTo(object, object, Type)

ObjectExtensions.FieldsOf<T>(object)

ObjectExtensions.GetAttribute<T>(object)

ObjectExtensions.GetAttributes<T>(object)

ObjectExtensions.HasAttrValue<TAttribute, TValue>(object, out TValue)

ObjectExtensions.HasAttribute<T>(object)

ObjectExtensions.HasAttribute<T>(object, out T?)

ObjectExtensions.HasAttributes<T>(object, out IEnumerable<T>?)

ObjectExtensions.Is(object?, object?)

ObjectExtensions.IsEither(object, IEnumerable)

ObjectExtensions.IsEither(object, params object[])

ObjectExtensions.IsNeither(object, IEnumerable)

ObjectExtensions.IsNeither(object, params object[])

ObjectExtensions.IsNot(object?, object?)

ObjectExtensions.PropertiesOf<T>(object)

ObjectExtensions.WhichAre(object, IEnumerable<object>)

ObjectExtensions.WhichAre(object, params object[])

Common.IfNotNull<T>(T?, Action<T>)

Objects.Itself<T>(T)

Objects.ShallowCopyTo<T>(T, T)

CollectionExtensions.PushInto<TItem, TCollection>(TItem, ICollection<TCollection>)

DictionaryExtensions.PushInto<TKey, TValue>(TValue, TKey, IDictionary<TKey, TValue>)