urlobject

package
v0.6.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 16, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package urlobject implements the STIX 2.1 URL SCO object.

The following information comes directly from the STIX 2.1 specification.

The URL object represents the properties of a uniform resource locator (URL).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type URLObject

URLObject - This type implements the STIX 2 URL SCO and defines all of the properties and methods needed to create and work with this object. All of the methods not defined local to this type are inherited from the individual properties.

func Decode

func Decode(data []byte) (*URLObject, error)

Decode - This function is a simple wrapper for decoding JSON data. It will decode a slice of bytes into an actual struct and return a pointer to that object along with any errors.

func New

func New() *URLObject

New - This function will create a new STIX URL SCO and return it as a pointer. It will also initialize the object by setting all of the basic properties.

func (*URLObject) Encode

func (o *URLObject) Encode() ([]byte, error)

Encode - This method is a simple wrapper for encoding an object into JSON

func (*URLObject) EncodeToString

func (o *URLObject) EncodeToString() (string, error)

EncodeToString - This method is a simple wrapper for encoding an object into JSON

func (*URLObject) GetPropertyList

func (o *URLObject) GetPropertyList() []string

GetPropertyList - This method will return a list of all of the properties that are unique to this object. This is used by the custom UnmarshalJSON for this object. It is defined here in this file to make it easy to keep in sync.

func (*URLObject) UnmarshalJSON

func (o *URLObject) UnmarshalJSON(b []byte) error

UnmarshalJSON - This method will over write the default UnmarshalJSON method to enable custom properties that this library does not know about. It will store them as map where the value of each key is a byte arrays. This way a tool that does know how to deal with them can then further process them after this is done. This will also allow the storage of the raw JSON data.

func (*URLObject) Valid

func (o *URLObject) Valid() (bool, int, []string)

Valid - This method will verify and test all of the properties on an object to make sure they are valid per the specification. It will return a boolean, an integer that tracks the number of problems found, and a slice of strings that contain the detailed results, whether good or bad.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL