Skip to content

struct QueryString

cangjie
public struct QueryString <: Equatable<QueryString> & Equatable<String> & Hashable & ToString

功能:表示带前导问号的查询字符串。

父类型:

  • Equatable<QueryString>
  • Equatable<String>
  • Hashable
  • ToString

成员概览

成员功能
init(String)使用原始查询字符串值创建实例。
let empty表示空查询字符串。
prop value返回原始查询字符串值。
prop hasValue检查当前查询字符串是否包含值。
func toUriComponent()返回适合组合到 URI 中的查询字符串表示。
func fromUriComponent(String)从 URI 查询部分创建查询字符串实例。
func create(String, String)使用单个键值对创建查询字符串。
func create(Collection<(String, String)>)使用键值对集合创建查询字符串。
func create(Collection<(String, StringValues)>)使用多值参数集合创建查询字符串。
func add(QueryString)将另一个查询字符串追加到当前实例后面。
func add(String, String)向当前查询字符串追加一个键值对。
func ==(QueryString)比较两个查询字符串是否相等。
func !=(QueryString)比较两个查询字符串是否不相等。
func ==(String)比较当前查询字符串与字符串值是否相等。
func +(QueryString)使用加号运算符合并两个查询字符串。
func hashCode()返回当前查询字符串的哈希值。
func toString()返回当前查询字符串的字符串表示。

init(String)

cangjie
public init(value: String)

功能:使用原始查询字符串值创建实例。

参数:

  • value: String - 原始查询字符串值。

异常:

  • IllegalArgumentException - 当非空值缺少前导问号时抛出。

let empty

cangjie
public static let empty = QueryString(String.empty)

功能:表示空查询字符串。

prop value

cangjie
public prop value: String

功能:返回原始查询字符串值。

类型:String

prop hasValue

cangjie
public prop hasValue: Bool

功能:检查当前查询字符串是否包含值。

类型:Bool

func toUriComponent()

cangjie
public func toUriComponent(): String

功能:返回适合组合到 URI 中的查询字符串表示。

返回值:

  • String - 转义后的查询字符串表示。

func fromUriComponent(String)

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

功能:从 URI 查询部分创建查询字符串实例。

参数:

  • uriComponent: String - URI 中的查询部分。

返回值:

func create(String, String)

cangjie
public static func create(name: String, value: String): QueryString

功能:使用单个键值对创建查询字符串。

参数:

  • name: String - 查询参数名称。
  • value: String - 查询参数值。

返回值:

func create(Collection<(String, String)>)

cangjie
public static func create(parameters: Collection<(String, String)>): QueryString

功能:使用键值对集合创建查询字符串。

参数:

  • parameters: Collection<(String, String)> - 查询参数键值对集合。

返回值:

func create(Collection<(String, StringValues)>)

cangjie
public static func create(parameters: Collection<(String, StringValues)>): QueryString

功能:使用多值参数集合创建查询字符串。

参数:

  • parameters: Collection<(String, StringValues)> - 查询参数及其多值集合。

返回值:

func add(QueryString)

cangjie
public func add(other: QueryString): QueryString

功能:将另一个查询字符串追加到当前实例后面。

参数:

返回值:

func add(String, String)

cangjie
public func add(name: String, value: String): QueryString

功能:向当前查询字符串追加一个键值对。

参数:

  • name: String - 查询参数名称。
  • value: String - 查询参数值。

返回值:

func ==(QueryString)

cangjie
public operator func ==(that: QueryString): Bool

功能:比较两个查询字符串是否相等。

参数:

返回值:

  • Bool - 如果两个查询字符串相等则返回 true,否则返回 false。

func !=(QueryString)

cangjie
public operator func !=(that: QueryString): Bool

功能:比较两个查询字符串是否不相等。

参数:

返回值:

  • Bool - 如果两个查询字符串不相等则返回 true,否则返回 false。

func ==(String)

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

功能:比较当前查询字符串与字符串值是否相等。

参数:

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

返回值:

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

func +(QueryString)

cangjie
public operator func +(that: QueryString): QueryString

功能:使用加号运算符合并两个查询字符串。

参数:

返回值:

func hashCode()

cangjie
public func hashCode(): Int64

功能:返回当前查询字符串的哈希值。

返回值:

  • Int64 - 当前查询字符串的哈希值。

func toString()

cangjie
public func toString(): String

功能:返回当前查询字符串的字符串表示。

返回值:

  • String - 当前查询字符串的字符串表示。