package soap

Import Path
	github.com/huin/goupnp/soap (on go.dev)

Dependency Relation
	imports 16 packages, and imported by 3 packages

Involved Source Files

	    soap.go
	    types.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type SOAPClient (struct)

		Fields (total 2)
			EndpointURL url.URL
			HTTPClient http.Client
		Methods (total 2)
			(*SOAPClient) PerformAction(actionNamespace, actionName string, inAction interface{}, outAction interface{}) error
				PerformAction is the legacy version of PerformActionCtx, which uses
				context.Background.

			(*SOAPClient) PerformActionCtx(ctx context.Context, actionNamespace, actionName string, inAction interface{}, outAction interface{}) error
				PerformSOAPAction makes a SOAP request, with the given action.
				inAction and outAction must both be pointers to structs with string fields
				only.

		As Outputs Of (at least 2)
			func NewSOAPClient(endpointURL url.URL) *SOAPClient
			func github.com/huin/goupnp.(*Service).NewSOAPClient() *SOAPClient

	 type SOAPFaultError (struct)
		SOAPFaultError implements error, and contains SOAP fault information.

		Fields (total 3)
			Detail struct{UPnPError struct{Errorcode int; ErrorDescription string}; Raw []byte}
			FaultCode string
			FaultString string
		Methods (only one)
			(*SOAPFaultError) Error() string
		Implements (at least one exported)
			*SOAPFaultError : error

	 type TimeOfDay (struct)
		TimeOfDay is used in cases where SOAP "time" or "time.tz" is used.

		Fields (total 3)
			FromMidnight time.Duration
				Duration of time since midnight.

			HasOffset bool
				Set to true if Offset is specified. If false, then the timezone is
				unspecified (and by ISO8601 - implies some "local" time).

			Offset int
				Offset is non-zero only if time.tz is used. It is otherwise ignored. If
				non-zero, then it is regarded as a UTC offset in seconds. Note that the
				sub-minutes is ignored by the marshal function.

		As Outputs Of (at least 2)
			func UnmarshalTimeOfDay(s string) (TimeOfDay, error)
			func UnmarshalTimeOfDayTz(s string) (tod TimeOfDay, err error)
		As Inputs Of (at least 2)
			func MarshalTimeOfDay(v TimeOfDay) (string, error)
			func MarshalTimeOfDayTz(v TimeOfDay) (string, error)

	 type TypeData (struct)
		TypeData provides metadata about for marshalling and unmarshalling a SOAP
		type.

		Methods (total 3)
			( TypeData) GoTypeName() string
				GoTypeName returns the name of the Go type.

			( TypeData) MarshalFunc() string
				MarshalFunc returns the name of the function that marshals the type.

			( TypeData) UnmarshalFunc() string
				UnmarshalFunc returns the name of the function that unmarshals the type.



Package-Level Functions (total 45)

	 func MarshalBinBase64(v []byte) (string, error)
		MarshalBinBase64 marshals []byte to SOAP "bin.base64" type.

	 func MarshalBinHex(v []byte) (string, error)
		MarshalBinHex marshals []byte to SOAP "bin.hex" type.

	 func MarshalBoolean(v bool) (string, error)
		MarshalBoolean marshals bool to SOAP "boolean" type.

	 func MarshalChar(v rune) (string, error)
		MarshalChar marshals rune to SOAP "char" type.

	 func MarshalDate(v time.Time) (string, error)
		MarshalDate marshals time.Time to SOAP "date" type. Note that this converts
		to local time, and discards the time-of-day components.

	 func MarshalDateTime(v time.Time) (string, error)
		MarshalDateTime marshals time.Time to SOAP "dateTime" type. Note that this
		converts to local time.

	 func MarshalDateTimeTz(v time.Time) (string, error)
		MarshalDateTimeTz marshals time.Time to SOAP "dateTime.tz" type.

	 func MarshalFixed14_4(v float64) (string, error)
		MarshalFixed14_4 marshals float64 to SOAP "fixed.14.4" type.

	 func MarshalI1(v int8) (string, error)
	 func MarshalI2(v int16) (string, error)
	 func MarshalI4(v int32) (string, error)
	 func MarshalInt(v int64) (string, error)
	 func MarshalR4(v float32) (string, error)
	 func MarshalR8(v float64) (string, error)
	 func MarshalString(v string) (string, error)
	 func MarshalTimeOfDay(v TimeOfDay) (string, error)
		MarshalTimeOfDay marshals TimeOfDay to the "time" type.

	 func MarshalTimeOfDayTz(v TimeOfDay) (string, error)
		MarshalTimeOfDayTz marshals TimeOfDay to the "time.tz" type.

	 func MarshalUi1(v uint8) (string, error)
	 func MarshalUi2(v uint16) (string, error)
	 func MarshalUi4(v uint32) (string, error)
	 func MarshalUi8(v uint64) (string, error)
	 func MarshalURI(v *url.URL) (string, error)
		MarshalURI marshals *url.URL to SOAP "uri" type.

	 func NewSOAPClient(endpointURL url.URL) *SOAPClient
	 func UnmarshalBinBase64(s string) ([]byte, error)
		UnmarshalBinBase64 unmarshals []byte from the SOAP "bin.base64" type.

	 func UnmarshalBinHex(s string) ([]byte, error)
		UnmarshalBinHex unmarshals []byte from the SOAP "bin.hex" type.

	 func UnmarshalBoolean(s string) (bool, error)
		UnmarshalBoolean unmarshals bool from the SOAP "boolean" type.

	 func UnmarshalChar(s string) (rune, error)
		UnmarshalChar unmarshals rune from SOAP "char" type.

	 func UnmarshalDate(s string) (time.Time, error)
		UnmarshalDate unmarshals time.Time from SOAP "date" type. This outputs the
		date as midnight in the local time zone.

	 func UnmarshalDateTime(s string) (result time.Time, err error)
		UnmarshalDateTime unmarshals time.Time from the SOAP "dateTime" type. This
		returns a value in the local timezone.

	 func UnmarshalDateTimeTz(s string) (result time.Time, err error)
		UnmarshalDateTimeTz unmarshals time.Time from the SOAP "dateTime.tz" type.
		This returns a value in the local timezone when the timezone is unspecified.

	 func UnmarshalFixed14_4(s string) (float64, error)
		UnmarshalFixed14_4 unmarshals float64 from SOAP "fixed.14.4" type.

	 func UnmarshalI1(s string) (int8, error)
	 func UnmarshalI2(s string) (int16, error)
	 func UnmarshalI4(s string) (int32, error)
	 func UnmarshalInt(s string) (int64, error)
	 func UnmarshalR4(s string) (float32, error)
	 func UnmarshalR8(s string) (float64, error)
	 func UnmarshalString(v string) (string, error)
	 func UnmarshalTimeOfDay(s string) (TimeOfDay, error)
		UnmarshalTimeOfDay unmarshals TimeOfDay from the "time" type.

	 func UnmarshalTimeOfDayTz(s string) (tod TimeOfDay, err error)
		UnmarshalTimeOfDayTz unmarshals TimeOfDay from the "time.tz" type.

	 func UnmarshalUi1(s string) (uint8, error)
	 func UnmarshalUi2(s string) (uint16, error)
	 func UnmarshalUi4(s string) (uint32, error)
	 func UnmarshalUi8(s string) (uint64, error)
	 func UnmarshalURI(s string) (*url.URL, error)
		UnmarshalURI unmarshals *url.URL from the SOAP "uri" type.


Package-Level Variables (only one)

	  var TypeDataMap map[string]TypeData
		TypeDataMap maps from a SOAP type (e.g "fixed.14.4") to its type data.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.