PathString Structure
Provides correct escaping for Path and PathBase values when needed to reconstruct a request or redirect URI string
Namespace: Microsoft.Owin
Assembly: Microsoft.Owin (in Microsoft.Owin.dll)
Syntax
public struct PathString : IEquatable<PathString>
public value struct PathString : IEquatable<PathString>
[<Sealed>]
type PathString =
struct
interface IEquatable<PathString>
end
Public Structure PathString
Implements IEquatable(Of PathString)
Constructors
Name | Description | |
---|---|---|
PathString(String) | Initialize the path string with a given value. This value must be in un-escaped format. Use PathString.FromUriComponent(value) if you have a path value which is in an escaped format. |
Properties
Name | Description | |
---|---|---|
HasValue | True if the path is not empty |
|
Value | The unescaped path value |
Methods
Name | Description | |
---|---|---|
Add(PathString) | Adds two PathString instances into a combined PathString value. |
|
Add(QueryString) | Combines a PathString and QueryString into the joined URI formatted string value. |
|
Equals(Object) | Compares this PathString value to another value. The default comparison is StringComparison.OrdinalIgnoreCase.(Overrides ValueType.Equals(Object).) |
|
Equals(PathString) | Compares this PathString value to another value. The default comparison is StringComparison.OrdinalIgnoreCase. |
|
Equals(PathString, StringComparison) | Compares this PathString value to another value using a specific StringComparison type |
|
FromUriComponent(String) | Returns an PathString given the path as it is escaped in the URI format. The string MUST NOT contain any value that is not a path. |
|
FromUriComponent(Uri) | Returns an PathString given the path as from a Uri object. Relative Uri objects are not supported. |
|
GetHashCode() | Returns the hash code for the PathString value. The hash code is provided by the OrdinalIgnoreCase implementation.(Overrides ValueType.GetHashCode().) |
|
GetType() | (Inherited from Object.) |
|
StartsWithSegments(PathString) | Checks if this instance starts with or exactly matches the other instance. Only full segments are matched. |
|
StartsWithSegments(PathString, PathString) | Checks if this instance starts with or exactly matches the other instance. Only full segments are matched. |
|
ToString() | Provides the path string escaped in a way which is correct for combining into the URI representation.(Overrides ValueType.ToString().) |
|
ToUriComponent() | Provides the path string escaped in a way which is correct for combining into the URI representation. |
Fields
Name | Description | |
---|---|---|
Empty | Represents the empty path. This field is read-only. |
Operators
Name | Description | |
---|---|---|
Addition(PathString, PathString) | Operator call through to Add |
|
Addition(PathString, QueryString) | Operator call through to Add |
|
Equality(PathString, PathString) | Operator call through to Equals |
|
Inequality(PathString, PathString) | Operator call through to Equals |
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
Return to top