PathString Struct
Definition
Provides correct escaping for Path and PathBase values when needed to reconstruct a request or redirect URI string
public value class PathString : IEquatable<Microsoft::AspNetCore::Http::PathString>public struct PathString : IEquatable<Microsoft.AspNetCore.Http.PathString>[System.ComponentModel.TypeConverter(typeof(Microsoft.AspNetCore.Http.PathStringConverter))]
public struct PathString : IEquatable<Microsoft.AspNetCore.Http.PathString>type PathString = struct[<System.ComponentModel.TypeConverter(typeof(Microsoft.AspNetCore.Http.PathStringConverter))>]
type PathString = structPublic Structure PathString
Implements IEquatable(Of PathString)- Inheritance
-
PathString
- Attributes
- Implements
Constructors
| PathString(String) |
Initialize the path string with a given value. This value must be in unescaped format. Use PathString.FromUriComponent(value) if you have a path value which is in an escaped format. |
Fields
| Empty |
Represents the empty path. This field is read-only. |
Properties
| HasValue |
True if the path is not empty |
| Value |
The unescaped path value |
Methods
| 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. |
| 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. |
| StartsWithSegments(PathString) |
Determines whether the beginning of this PathString instance matches the specified PathString. |
| StartsWithSegments(PathString, PathString) |
Determines whether the beginning of this PathString instance matches the specified PathString and returns the remaining segments. |
| StartsWithSegments(PathString, PathString, PathString) |
Determines whether the beginning of this PathString instance matches the specified PathString and returns the matched and remaining segments. |
| StartsWithSegments(PathString, StringComparison) |
Determines whether the beginning of this PathString instance matches the specified PathString when compared using the specified comparison option. |
| StartsWithSegments(PathString, StringComparison, PathString) |
Determines whether the beginning of this PathString instance matches the specified PathString when compared using the specified comparison option and returns the remaining segments. |
| StartsWithSegments(PathString, StringComparison, PathString, PathString) |
Determines whether the beginning of this PathString instance matches the specified PathString when compared using the specified comparison option and returns the matched and remaining segments. |
| ToString() |
Provides the path string escaped in a way which is correct for combining into the URI representation. |
| ToUriComponent() |
Provides the path string escaped in a way which is correct for combining into the URI representation. |
Operators
| Addition(PathString, PathString) |
Operator call through to Add |
| Addition(PathString, QueryString) |
Operator call through to Add |
| Addition(PathString, String) | |
| Addition(String, PathString) | |
| Equality(PathString, PathString) |
Operator call through to Equals |
| Implicit(PathString to String) |
Implicitly calls ToString(). |
| Implicit(String to PathString) |
Implicitly creates a new PathString from the given string. |
| Inequality(PathString, PathString) |
Operator call through to Equals |