Spire 天擎

外观

struct HostString ​

cangjie
public struct HostString <: Equatable<HostString> & Equatable<String> & ToString

功能：表示 URI 的主机部分。

支持 IPv4、IPv6 以及可选端口，可用于构造格式化后的主机头值。

父类型：

成员概览 ​

成员功能
init(String)使用原始主机字符串创建实例。
init(String, Int64)使用主机名和端口创建实例。
prop value返回原始主机字符串值。
prop hasValue检查当前实例是否包含主机值。
prop host返回主机部分。
prop port返回端口部分。
func toUriComponent()返回适合写入 URI 组件的主机字符串。
func fromUriComponent(String)从 URI 主机组件创建实例。
func matchesAny(String, Collection<String>)检查主机值是否匹配任一模式。
func ==(HostString)比较两个主机字符串是否相等。
func ==(String)比较当前实例与字符串值是否相等。
func toString()返回当前实例的字符串表示。

init(String) ​

cangjie
public init(value: String)

功能：使用原始主机字符串创建实例。

参数：

  • value: String - 原始主机字符串值。

init(String, Int64) ​

cangjie
public init(host: String, port: Int64)

功能：使用主机名和端口创建实例。

参数：

  • host: String - 主机名或 IP 地址。
  • port: Int64 - 端口号。

异常：

  • IllegalArgumentException - 当端口号小于或等于 0 时抛出。

prop value ​

cangjie
public prop value: String

功能：返回原始主机字符串值。

类型：String

prop hasValue ​

cangjie
public prop hasValue: Bool

功能：检查当前实例是否包含主机值。

类型：Bool

prop host ​

cangjie
public prop host: String

功能：返回主机部分。

类型：String

prop port ​

cangjie
public prop port: ?Int64

功能：返回端口部分。

类型：?Int64

func toUriComponent() ​

cangjie
public func toUriComponent(): String

功能：返回适合写入 URI 组件的主机字符串。

返回值：

  • String - 当前实例的 URI 组件表示。

func fromUriComponent(String) ​

cangjie
public static func fromUriComponent(uriComponent: String): HostString

功能：从 URI 主机组件创建实例。

参数：

  • uriComponent: String - URI 中的主机组件。

返回值：

func matchesAny(String, Collection<String>) ​

cangjie
public static func matchesAny(value: String, patterns: Collection<String>): Bool

功能：检查主机值是否匹配任一模式。

比较时会忽略主机值中的端口部分，支持精确匹配、全通配符和子域名通配符。

参数：

  • value: String - 要匹配的主机值。
  • patterns: Collection<String> - 主机匹配模式集合。

返回值：

  • Bool - 如果主机值匹配任一模式则返回 true，否则返回 false。

异常：

  • IllegalArgumentException - 当主机值中的端口格式非法时抛出。

func ==(HostString) ​

cangjie
public operator func ==(other: HostString): Bool

功能：比较两个主机字符串是否相等。

参数：

  • other: HostString - 要比较的主机字符串。

返回值：

  • Bool - 如果两个主机字符串相等则返回 true，否则返回 false。

func ==(String) ​

cangjie
public operator func ==(value: String): Bool

功能：比较当前实例与字符串值是否相等。

参数：

  • value: String - 要比较的字符串值。

返回值：

  • Bool - 如果两者相等则返回 true，否则返回 false。

func toString() ​

cangjie
public func toString(): String

功能：返回当前实例的字符串表示。

返回值：

  • String - 当前实例的 URI 组件表示。