go-smbios

https://pkg.go.dev/github.com/siderolabs/go-smbios
Admin
go-smbios is a Go library that provides low-level access to System Management BIOS (SMBIOS) and...
Tokens:22,903
Snippets:216
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install go-smbios Package

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios/internal/github.com/digitalocean/go-smbios

To install the go-smbios package, use the go get command. Ensure you are using the correct path for your project.

```go
go get github.com/digitalocean/go-smbios/smbios

```

--------------------------------

### Retrieve and Decode SMBIOS Data

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios/internal/github.com/digitalocean/go-smbios

This example demonstrates how to find, open, and decode SMBIOS structures from the operating system. It also prints the SMBIOS version and table information. Retrieving SMBIOS data is a privileged operation.

```go
// Find SMBIOS data in operating system-specific location.
rc, ep, err := smbios.Stream()
if err != nil {
	log.Fatalf("failed to open stream: %v", err)
}
// Be sure to close the stream!
deferrc.Close()

// Decode SMBIOS structures from the stream.
d := smbios.NewDecoder(rc)
ss, err := d.Decode()
if err != nil {
	log.Fatalf("failed to decode structures: %v", err)
}

// Determine SMBIOS version and table location from entry point.
major, minor, rev := ep.Version()
addr, size := ep.Table()

fmt.Printf("SMBIOS %d.%d.%d - table: address: %#x, size: %d\n",
	major, minor, rev, addr, size)

for _, s := range ss {
	fmt.Println(s)
}

```

--------------------------------

### Get SMBIOS Table Info (64-bit)

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios/internal/github.com/digitalocean/go-smbios/smbios

Retrieves the memory address and size of the SMBIOS table from a 64-bit entry point structure.

```go
func (e *EntryPoint64Bit) Table() (address, size int)
```

--------------------------------

### Get SMBIOS Table Info (32-bit)

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios/internal/github.com/digitalocean/go-smbios/smbios

Retrieves the memory address and size of the SMBIOS table from a 32-bit entry point structure.

```go
func (e *EntryPoint32Bit) Table() (address, size int)
```

--------------------------------

### Get SMBIOS Table Info (Windows)

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios/internal/github.com/digitalocean/go-smbios/smbios

Retrieves the memory address and size of the SMBIOS table from a Windows-specific entry point structure.

```go
func (e *WindowsEntryPoint) Table() (address, size int)
```

--------------------------------

### Get SMBIOS Version (64-bit)

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios/internal/github.com/digitalocean/go-smbios/smbios

Retrieves the major, minor, and revision numbers of the SMBIOS version from a 64-bit entry point structure.

```go
func (e *EntryPoint64Bit) Version() (major, minor, revision int)
```

--------------------------------

### Get SMBIOS Version (32-bit)

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios/internal/github.com/digitalocean/go-smbios/smbios

Retrieves the major, minor, and revision numbers of the SMBIOS version from a 32-bit entry point structure.

```go
func (e *EntryPoint32Bit) Version() (major, minor, revision int)
```

--------------------------------

### Get SMBIOS Version (Windows)

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios/internal/github.com/digitalocean/go-smbios/smbios

Retrieves the major, minor, and revision numbers of the SMBIOS version from a Windows-specific entry point structure.

```go
func (e *WindowsEntryPoint) Version() (major, minor, revision int)
```

--------------------------------

### String representation for ExtendedMaximumCapacity

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Method to get the string representation of an `ExtendedMaximumCapacity` value.

```go
func (m ExtendedMaximumCapacity) String() string
```

--------------------------------

### Initialize SystemConfigurationOptions

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

The NewSystemConfigurationOptions function initializes and returns a new SystemConfigurationOptions struct, taking an SMBIOS structure as input.

```go
func NewSystemConfigurationOptions(s *smbios.Structure) *SystemConfigurationOptions
```

--------------------------------

### Initialize SystemInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

The NewSystemInformation function initializes and returns a new SystemInformation struct. It requires an SMBIOS structure and the SMBIOS version.

```go
func NewSystemInformation(s *smbios.Structure, v Version) *SystemInformation
```

--------------------------------

### String representation for BoardType

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Method to get the string representation of a `BoardType` enum value.

```go
func (w BoardType) String() string
```

--------------------------------

### Initialize New BaseboardInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Constructor function to initialize and return a new `BaseboardInformation` struct.

```go
func NewBaseboardInformation(s *smbios.Structure) *BaseboardInformation
```

--------------------------------

### Initialize SystemSlot

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

The NewSystemSlot function initializes and returns a new SystemSlot struct, taking an SMBIOS structure as input.

```go
func NewSystemSlot(s *smbios.Structure) *SystemSlot
```

--------------------------------

### Initialize New SMBIOS

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

The New function initializes and returns a new SMBIOS struct. It does not take any arguments.

```go
func New() (*SMBIOS, error)
```

--------------------------------

### Initialize GroupAssociations

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Initializes and returns a new `GroupAssociations` structure. Requires a pointer to an SMBIOS structure.

```go
func NewGroupAssociations(s *smbios.Structure) *GroupAssociations
```

--------------------------------

### NewBaseboardInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Initializes and returns a new BaseboardInformation struct from an smbios.Structure.

```APIDOC
## func NewBaseboardInformation(s *smbios.Structure) *BaseboardInformation

### Description
Initializes and returns a new `BaseboardInformation`.

### Parameters
- **s** (*smbios.Structure) - The SMBIOS structure to parse.
```

--------------------------------

### BIOSLanguageInformation struct definition

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Represents the SMBIOS BIOS language information, including the current language and a list of installable languages. This struct helps manage language settings reported by the BIOS.

```go
type BIOSLanguageInformation struct {
	// CurrentLanguage returns the current language.
	CurrentLanguage string
	// InstallableLanguages returns the installable languages.
	InstallableLanguages []string
}
```

--------------------------------

### NewSystemConfigurationOptions

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Creates a SystemConfigurationOptions structure from an SMBIOS structure.

```APIDOC
## NewSystemConfigurationOptions

### Description
Creates a SystemConfigurationOptions structure from an SMBIOS structure.

### Method
func NewSystemConfigurationOptions(s *smbios.Structure) *SystemConfigurationOptions

### Parameters
#### Path Parameters
- **s** (*smbios.Structure) - The SMBIOS structure containing system configuration options.

### Response
- **SystemConfigurationOptions** (*SystemConfigurationOptions) - A pointer to the SystemConfigurationOptions structure.
```

--------------------------------

### NewSystemSlot

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Creates a SystemSlot structure from an SMBIOS structure.

```APIDOC
## NewSystemSlot

### Description
Creates a SystemSlot structure from an SMBIOS structure.

### Method
func NewSystemSlot(s *smbios.Structure) *SystemSlot

### Parameters
#### Path Parameters
- **s** (*smbios.Structure) - The SMBIOS structure containing system slot information.

### Response
- **SystemSlot** (*SystemSlot) - A pointer to the SystemSlot structure.
```

--------------------------------

### SystemConfigurationOptions

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Represents the SMBIOS system configuration options, including available strings and their count.

```APIDOC
## SystemConfigurationOptions

### Description
SystemConfigurationOptions represents the SMBIOS system configuration options.

### Fields
- **Strings** ([]string) - Returns the actual strings.
- **Count** (uint8) - Returns the number of strings.
```

```APIDOC
## NewSystemConfigurationOptions

### Description
NewSystemConfigurationOptions initializes and returns a new `SystemConfigurationOptions`.

### Method
```go
func NewSystemConfigurationOptions(s *smbios.Structure) *SystemConfigurationOptions
```

### Parameters
- **s** (*smbios.Structure) - The SMBIOS structure to initialize from.
```

--------------------------------

### New SMBIOS Instance

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Creates a new, empty SMBIOS structure.

```APIDOC
## New

### Description
Creates a new, empty SMBIOS structure.

### Method
func New() (*SMBIOS, error)

### Response
#### Success Response (SMBIOS)
- **SMBIOS** (*smbios.SMBIOS) - A pointer to a new SMBIOS structure.
#### Error Response
- **error** (error) - An error if the creation fails.
```

--------------------------------

### NewBaseboardInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Creates a BaseboardInformation structure from an SMBIOS structure.

```APIDOC
## NewBaseboardInformation

### Description
Creates a BaseboardInformation structure from an SMBIOS structure.

### Method
func NewBaseboardInformation(s *smbios.Structure) *BaseboardInformation

### Parameters
#### Path Parameters
- **s** (*smbios.Structure) - The SMBIOS structure containing baseboard information.

### Response
- **BaseboardInformation** (*BaseboardInformation) - A pointer to the BaseboardInformation structure.
```

--------------------------------

### EntryPoint

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios/internal/github.com/digitalocean/go-smbios/smbios

An EntryPoint represents the SMBIOS entry point, providing access to table information and version details. Use ParseEntryPoint or Stream to obtain an EntryPoint.

```APIDOC
## func ParseEntryPoint(r io.Reader) (EntryPoint, error)

ParseEntryPoint parses an EntryPoint from the input stream.
```

```APIDOC
## func Stream() (io.ReadCloser, EntryPoint, error)

Stream locates and opens a stream of SMBIOS data and the SMBIOS entry point from an operating system-specific location. The stream must be closed after decoding to free its resources. If no suitable location is found, an error is returned.
```

```APIDOC
## func (e *EntryPoint32Bit) Table() (address, size int)

Table implements EntryPoint. It returns the memory address and maximum size of the SMBIOS table.
```

```APIDOC
## func (e *EntryPoint32Bit) Version() (major, minor, revision int)

Version implements EntryPoint. It returns the system's SMBIOS version.
```

```APIDOC
## func (e *EntryPoint64Bit) Table() (address, size int)

Table implements EntryPoint. It returns the memory address and maximum size of the SMBIOS table.
```

```APIDOC
## func (e *EntryPoint64Bit) Version() (major, minor, revision int)

Version implements EntryPoint. It returns the system's SMBIOS version.
```

```APIDOC
## func (e *WindowsEntryPoint) Table() (address, size int)

Table implements EntryPoint. It returns the memory address and maximum size of the SMBIOS table.
```

```APIDOC
## func (e *WindowsEntryPoint) Version() (major, minor, revision int)

Version implements EntryPoint. It returns the system's SMBIOS version.
```

--------------------------------

### Initialize SystemEnclosure

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

The NewSystemEnclosure function initializes and returns a new SystemEnclosure struct, taking an SMBIOS structure as input.

```go
func NewSystemEnclosure(s *smbios.Structure) *SystemEnclosure
```

--------------------------------

### Initialize New SMBIOS

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Creates and returns a new, uninitialized SMBIOS structure. This is useful for creating SMBIOS data programmatically.

```APIDOC
## New

### Description
New initializes and returns a new `SMBIOS`.

### Method
```go
func New() (*SMBIOS, error)
```

### Returns
- **(*SMBIOS, error)** - A pointer to a new SMBIOS structure and an error if initialization fails.
```

--------------------------------

### Initialize New CacheInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Constructor function to initialize and return a new `CacheInformation` struct.

```go
func NewCacheInformation(s *smbios.Structure) *CacheInformation
```

--------------------------------

### NewBIOSInformation initializes BIOSInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Initializes and returns a new `BIOSInformation` struct by parsing an SMBIOS structure. This is the constructor for the `BIOSInformation` type.

```go
func NewBIOSInformation(s *smbios.Structure) *BIOSInformation
```

--------------------------------

### Constructor for PortConnectorInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Initializes and returns a new PortConnectorInformation structure from a given smbios.Structure. This function parses SMBIOS data related to port connectors.

```go
func NewPortConnectorInformation(s *smbios.Structure) *PortConnectorInformation
```

--------------------------------

### NewProcessorInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Initializes and returns a new ProcessorInformation structure.

```APIDOC
## NewProcessorInformation

### Description
Initializes and returns a new `ProcessorInformation`.

### Signature
```go
func NewProcessorInformation(s *smbios.Structure) *ProcessorInformation
```
```

--------------------------------

### Version Method

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios/internal/github.com/digitalocean/go-smbios/smbios

The Version method for WindowsEntryPoint returns the major, minor, and revision components of the SMBIOS version.

```APIDOC
## func (*WindowsEntryPoint) Version() (major, minor, revision int)

Version implements EntryPoint.
```

--------------------------------

### Constructor for ProcessorInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Initializes and returns a new ProcessorInformation structure from a given smbios.Structure. This function is used to parse SMBIOS processor data.

```go
func NewProcessorInformation(s *smbios.Structure) *ProcessorInformation
```

--------------------------------

### NewSystemInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Creates a SystemInformation structure from an SMBIOS structure and version.

```APIDOC
## NewSystemInformation

### Description
Creates a SystemInformation structure from an SMBIOS structure and version.

### Method
func NewSystemInformation(s *smbios.Structure, v Version) *SystemInformation

### Parameters
#### Path Parameters
- **s** (*smbios.Structure) - The SMBIOS structure containing system information.
- **v** (Version) - The SMBIOS version.

### Response
- **SystemInformation** (*SystemInformation) - A pointer to the SystemInformation structure.
```

--------------------------------

### NewMemoryDevice

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Initializes and returns a new MemoryDevice structure from a given SMBIOS structure.

```APIDOC
## func NewMemoryDevice

### Description
Initializes and returns a new `MemoryDevice`.

### Signature
```go
func NewMemoryDevice(s *smbios.Structure) *MemoryDevice
```
```

--------------------------------

### Parse SMBIOS Entry Point

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios/internal/github.com/digitalocean/go-smbios/smbios

Parses an SMBIOS EntryPoint from an io.Reader. This function is used to locate and interpret the SMBIOS entry point data.

```go
func ParseEntryPoint(r io.Reader) (EntryPoint, error)
```

--------------------------------

### WindowsEntryPoint Structure

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios/internal/github.com/digitalocean/go-smbios/smbios

Defines the structure for SMBIOS Table entry point data obtained from GetSystemFirmwareTable on Windows. Note that full memory access is not provided, limiting the available information.

```go
type WindowsEntryPoint struct {
	Size         uint32
	MajorVersion byte
	MinorVersion byte
	Revision     byte
}
```

--------------------------------

### NewBIOSLanguageInformation initializes BIOSLanguageInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Initializes and returns a new `BIOSLanguageInformation` struct by parsing an SMBIOS structure. This function is used to create instances of the `BIOSLanguageInformation` type.

```go
func NewBIOSLanguageInformation(s *smbios.Structure) *BIOSLanguageInformation
```

--------------------------------

### Implement SocketPopulated Method for ProcessorStatus

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Implements the SocketPopulated method for the ProcessorStatus type. Returns true if the SMBIOS processor socket is populated.

```go
func (s ProcessorStatus) SocketPopulated() bool
```

--------------------------------

### NewOEMStrings

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Creates an OEMStrings structure from an SMBIOS structure.

```APIDOC
## NewOEMStrings

### Description
Creates an OEMStrings structure from an SMBIOS structure.

### Method
func NewOEMStrings(s *smbios.Structure) *OEMStrings

### Parameters
#### Path Parameters
- **s** (*smbios.Structure) - The SMBIOS structure containing OEM strings.

### Response
- **OEMStrings** (*OEMStrings) - A pointer to the OEMStrings structure.
```

--------------------------------

### Constructor for PhysicalMemoryArray

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Initializes and returns a new PhysicalMemoryArray structure from a given smbios.Structure. This function is used to parse SMBIOS data into a usable Go struct.

```go
func NewPhysicalMemoryArray(s *smbios.Structure) *PhysicalMemoryArray
```

--------------------------------

### Version

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Represents the System Management BIOS version.

```APIDOC
## Version

### Description
Version represents the System Management BIOS version.

### Fields
- **Major** (int) - The major version number.
- **Minor** (int) - The minor version number.
- **Revision** (int) - The revision number.
```

--------------------------------

### NewProcessorInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Creates a ProcessorInformation structure from an SMBIOS structure.

```APIDOC
## NewProcessorInformation

### Description
Creates a ProcessorInformation structure from an SMBIOS structure.

### Method
func NewProcessorInformation(s *smbios.Structure) *ProcessorInformation

### Parameters
#### Path Parameters
- **s** (*smbios.Structure) - The SMBIOS structure containing processor information.

### Response
- **ProcessorInformation** (*ProcessorInformation) - A pointer to the ProcessorInformation structure.
```

--------------------------------

### NewSystemEnclosure

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Creates a SystemEnclosure structure from an SMBIOS structure.

```APIDOC
## NewSystemEnclosure

### Description
Creates a SystemEnclosure structure from an SMBIOS structure.

### Method
func NewSystemEnclosure(s *smbios.Structure) *SystemEnclosure

### Parameters
#### Path Parameters
- **s** (*smbios.Structure) - The SMBIOS structure containing system enclosure information.

### Response
- **SystemEnclosure** (*SystemEnclosure) - A pointer to the SystemEnclosure structure.
```

--------------------------------

### Define SystemConfigurationOptions Struct

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Defines the SystemConfigurationOptions struct, which represents SMBIOS system configuration options. It contains a slice of strings and a count.

```go
type SystemConfigurationOptions struct {
	// Strings returns the actual strings.
	Strings []string
	// Count return the number of strings
	Count uint8
}
```

--------------------------------

### NewCacheInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Initializes and returns a new CacheInformation struct from an smbios.Structure.

```APIDOC
## func NewCacheInformation(s *smbios.Structure) *CacheInformation

### Description
Initializes and returns a new `CacheInformation`.

### Parameters
- **s** (*smbios.Structure) - The SMBIOS structure to parse.
```

--------------------------------

### NewMemoryDevice

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Creates a MemoryDevice structure from an SMBIOS structure.

```APIDOC
## NewMemoryDevice

### Description
Creates a MemoryDevice structure from an SMBIOS structure.

### Method
func NewMemoryDevice(s *smbios.Structure) *MemoryDevice

### Parameters
#### Path Parameters
- **s** (*smbios.Structure) - The SMBIOS structure containing memory device information.

### Response
- **MemoryDevice** (*MemoryDevice) - A pointer to the MemoryDevice structure.
```

--------------------------------

### Table Method

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios/internal/github.com/digitalocean/go-smbios/smbios

The Table method for WindowsEntryPoint returns the address and size of the SMBIOS table. Note that the address will always be 0 as it is not provided by GetSystemFirmwareTable.

```APIDOC
## func (*WindowsEntryPoint) Table() (address, size int)

Table implements EntryPoint. The returned address will always be 0, as it is not returned by GetSystemFirmwareTable.
```

--------------------------------

### MemoryDeviceSize.String

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Returns a string representation of the MemoryDeviceSize.

```APIDOC
## MemoryDeviceSize.String

### Description
Returns a string representation of the MemoryDeviceSize.

### Method
func (m MemoryDeviceSize) String() string

### Parameters
#### Path Parameters
- **m** (MemoryDeviceSize) - The MemoryDeviceSize value.

### Response
- **string** - The string representation of the MemoryDeviceSize.
```

--------------------------------

### GetQWord

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Retrieves a 64-bit quad word (QWORD) from an SMBIOS structure at a given offset.

```APIDOC
## GetQWord

### Description
Retrieves a 64-bit quad word (QWORD) from an SMBIOS structure at a given offset.

### Method
func GetQWord(s *smbios.Structure, offset int) uint64

### Parameters
#### Path Parameters
- **s** (*smbios.Structure) - The SMBIOS structure to read from.
- **offset** (int) - The byte offset within the structure.

### Response
- **uint64** - The QWORD value at the specified offset.
```

--------------------------------

### GetStrings

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Retrieves all strings associated with an SMBIOS structure.

```APIDOC
## GetStrings

### Description
Retrieves all strings associated with an SMBIOS structure.

### Method
func GetStrings(s *smbios.Structure) []string

### Parameters
#### Path Parameters
- **s** (*smbios.Structure) - The SMBIOS structure containing the strings.

### Response
- **[]string** - A slice of strings found within the structure.
```

--------------------------------

### MemoryDeviceWidth.String

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Returns a string representation of the MemoryDeviceWidth.

```APIDOC
## MemoryDeviceWidth.String

### Description
Returns a string representation of the MemoryDeviceWidth.

### Method
func (m MemoryDeviceWidth) String() string

### Parameters
#### Path Parameters
- **m** (MemoryDeviceWidth) - The MemoryDeviceWidth value.

### Response
- **string** - The string representation of the MemoryDeviceWidth.
```

--------------------------------

### GetQWord retrieves a 64-bit unsigned integer

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Retrieves a 64-bit unsigned integer from a SMBIOS structure at the specified offset. Ensure the provided offset is valid for the structure.

```go
func GetQWord(s *smbios.Structure, offset int) uint64
```

--------------------------------

### NewPhysicalMemoryArray

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Creates a PhysicalMemoryArray structure from an SMBIOS structure.

```APIDOC
## NewPhysicalMemoryArray

### Description
Creates a PhysicalMemoryArray structure from an SMBIOS structure.

### Method
func NewPhysicalMemoryArray(s *smbios.Structure) *PhysicalMemoryArray

### Parameters
#### Path Parameters
- **s** (*smbios.Structure) - The SMBIOS structure containing physical memory array information.

### Response
- **PhysicalMemoryArray** (*PhysicalMemoryArray) - A pointer to the PhysicalMemoryArray structure.
```

--------------------------------

### NewPortConnectorInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Creates a PortConnectorInformation structure from an SMBIOS structure.

```APIDOC
## NewPortConnectorInformation

### Description
Creates a PortConnectorInformation structure from an SMBIOS structure.

### Method
func NewPortConnectorInformation(s *smbios.Structure) *PortConnectorInformation

### Parameters
#### Path Parameters
- **s** (*smbios.Structure) - The SMBIOS structure containing port connector information.

### Response
- **PortConnectorInformation** (*PortConnectorInformation) - A pointer to the PortConnectorInformation structure.
```

--------------------------------

### OEMStrings

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Represents the SMBIOS OEM strings, containing a slice of strings and their count.

```APIDOC
## type OEMStrings

### Description
OEMStrings represents the SMBIOS OEM strings.

### Fields
- **Strings** ([]string) - The actual strings.
- **Count** (uint8) - The number of strings.

### Type Definition
```go
type OEMStrings struct {
	Strings []string
	Count uint8
}
```

## func NewOEMStrings

### Description
NewOEMStrings initializes and returns a new `OEMStrings`.

### Signature
```go
func NewOEMStrings(s *smbios.Structure) *OEMStrings
```
```

--------------------------------

### Define BaseboardInformation Structure

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Defines the structure for SMBIOS baseboard information, including manufacturer, product, version, serial number, asset tag, location, and board type.

```go
type BaseboardInformation struct {
	// Manufacturer returns the baseboard manufacturer.
	Manufacturer string
	// Product returns the baseboard product.
	Product string
	// Version returns the baseboard version.
	Version string
	// SerialNumber returns the baseboard serial number.
	SerialNumber string
	// AssetTag returns the baseboard asset tag.
	AssetTag string
	// LocationInChassis returns the number of a null-terminated string that
	// describes this board's location within the chassis referenced by the
	// Chassis Handle (described below in this table)
	// NOTE: This field supports a CIM_Container class mapping where:
	// 	- LocationWithinContainer is this field.
	// 	- GroupComponent is the chassis referenced by Chassis Handle.
	// 	- PartComponent is this baseboard
	LocationInChassis string
	// BoardType identifies the type of board. See 7.3.2.
	BoardType BoardType
}
```

--------------------------------

### Define Version Struct

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Defines the Version struct, representing the System Management BIOS version with Major, Minor, and Revision fields.

```go
type Version struct {
	Major    int
	Minor    int
	Revision int
}
```

--------------------------------

### NewCacheInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Creates a CacheInformation structure from an SMBIOS structure.

```APIDOC
## NewCacheInformation

### Description
Creates a CacheInformation structure from an SMBIOS structure.

### Method
func NewCacheInformation(s *smbios.Structure) *CacheInformation

### Parameters
#### Path Parameters
- **s** (*smbios.Structure) - The SMBIOS structure containing cache information.

### Response
- **CacheInformation** (*CacheInformation) - A pointer to the CacheInformation structure.
```

--------------------------------

### NewPortConnectorInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Initializes and returns a new PortConnectorInformation structure.

```APIDOC
## NewPortConnectorInformation

### Description
Initializes and returns a new `PortConnectorInformation`.

### Signature
```go
func NewPortConnectorInformation(s *smbios.Structure) *PortConnectorInformation
```
```

--------------------------------

### GetWord

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Retrieves a 16-bit word from an SMBIOS structure at a given offset.

```APIDOC
## GetWord

### Description
Retrieves a 16-bit word from an SMBIOS structure at a given offset.

### Method
func GetWord(s *smbios.Structure, offset int) uint16

### Parameters
#### Path Parameters
- **s** (*smbios.Structure) - The SMBIOS structure to read from.
- **offset** (int) - The byte offset within the structure.

### Response
- **uint16** - The word value at the specified offset.
```

--------------------------------

### MemoryDeviceSpeed.String

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Returns a string representation of the MemoryDeviceSpeed.

```APIDOC
## MemoryDeviceSpeed.String

### Description
Returns a string representation of the MemoryDeviceSpeed.

### Method
func (m MemoryDeviceSpeed) String() string

### Parameters
#### Path Parameters
- **m** (MemoryDeviceSpeed) - The MemoryDeviceSpeed value.

### Response
- **string** - The string representation of the MemoryDeviceSpeed.
```

--------------------------------

### Define SystemInformation Struct

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Defines the SystemInformation struct, representing SMBIOS system information. It includes fields for manufacturer, product name, version, serial number, UUID, wake-up type, SKU number, and family.

```go
type SystemInformation struct {
	// Manufacturer returns the system manufacturer.
	Manufacturer string
	// ProductName returns the system product name.
	ProductName string
	// Version returns the system version.
	Version string
	// SerialNumber returns the system serial number.
	SerialNumber string
	// UUID returns the system UUID.
	UUID string
	// WakeUpType identifies the event that caused the system to
	// power up. See 7.2.2.
	WakeUpType WakeUpType
	// SKUNumber returns the system SKU number.
	SKUNumber string
	// Family returns the system family.
	Family string
}
```

--------------------------------

### String representation for FormFactor

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Returns the string representation of a memory device form factor.

```go
func (f FormFactor) String() string
```

--------------------------------

### Implement String Method for TypeDetail

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Implements the String method for the TypeDetail type, likely for string representation of the memory device details.

```go
func (t TypeDetail) String() string
```

--------------------------------

### BoardType.String

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Returns a string representation of the BoardType.

```APIDOC
## BoardType.String

### Description
Returns a string representation of the BoardType.

### Method
func (w BoardType) String() string

### Parameters
#### Path Parameters
- **w** (BoardType) - The BoardType value.

### Response
- **string** - The string representation of the BoardType.
```

--------------------------------

### BIOS Information Type

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Represents and provides a constructor for SMBIOS BIOS Information structures.

```APIDOC
## BIOSInformation

### Description
Represents the BIOS information structure, containing details about the system's BIOS.

### Fields
- **Vendor** (string): The vendor of the BIOS.
- **Version** (string): The version string of the BIOS.
- **ReleaseDate** (string): The release date of the BIOS.
```

```APIDOC
## NewBIOSInformation

### Description
Initializes and returns a new `BIOSInformation` struct populated with data from the given SMBIOS structure.

### Signature
```go
func NewBIOSInformation(s *smbios.Structure) *BIOSInformation
```

### Parameters
- **s** (*smbios.Structure) - The SMBIOS structure containing BIOS information.

### Returns
- *BIOSInformation: A pointer to the initialized `BIOSInformation` struct.
```

--------------------------------

### NewBIOSLanguageInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Creates a BIOSLanguageInformation structure from an SMBIOS structure.

```APIDOC
## NewBIOSLanguageInformation

### Description
Creates a BIOSLanguageInformation structure from an SMBIOS structure.

### Method
func NewBIOSLanguageInformation(s *smbios.Structure) *BIOSLanguageInformation

### Parameters
#### Path Parameters
- **s** (*smbios.Structure) - The SMBIOS structure containing BIOS language information.

### Response
- **BIOSLanguageInformation** (*BIOSLanguageInformation) - A pointer to the BIOSLanguageInformation structure.
```

--------------------------------

### GetStringOrEmpty retrieves a string or empty string

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Retrieves a string from a SMBIOS structure at the given offset. Returns an empty string if no string is present at the offset. Use this to safely access string data.

```go
func GetStringOrEmpty(s *smbios.Structure, offset int) string
```

--------------------------------

### NewPhysicalMemoryArray

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Initializes and returns a new PhysicalMemoryArray structure.

```APIDOC
## NewPhysicalMemoryArray

### Description
Initializes and returns a new `PhysicalMemoryArray`.

### Signature
```go
func NewPhysicalMemoryArray(s *smbios.Structure) *PhysicalMemoryArray
```
```

--------------------------------

### SystemInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Represents the SMBIOS system information, including manufacturer, product name, version, serial number, UUID, and wake-up type.

```APIDOC
## SystemInformation

### Description
SystemInformation represents the SMBIOS system information.

### Fields
- **Manufacturer** (string) - Returns the system manufacturer.
- **ProductName** (string) - Returns the system product name.
- **Version** (string) - Returns the system version.
- **SerialNumber** (string) - Returns the system serial number.
- **UUID** (string) - Returns the system UUID.
- **WakeUpType** (WakeUpType) - Identifies the event that caused the system to power up.
- **SKUNumber** (string) - Returns the system SKU number.
- **Family** (string) - Returns the system family.
```

```APIDOC
## NewSystemInformation

### Description
NewSystemInformation initializes and returns a new `SystemInformation`.

### Method
```go
func NewSystemInformation(s *smbios.Structure, v Version) *SystemInformation
```

### Parameters
- **s** (*smbios.Structure) - The SMBIOS structure to initialize from.
- **v** (Version) - The SMBIOS version.
```

--------------------------------

### NewGroupAssociations

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Creates a GroupAssociations structure from an SMBIOS structure.

```APIDOC
## NewGroupAssociations

### Description
Creates a GroupAssociations structure from an SMBIOS structure.

### Method
func NewGroupAssociations(s *smbios.Structure) *GroupAssociations

### Parameters
#### Path Parameters
- **s** (*smbios.Structure) - The SMBIOS structure containing group association information.

### Response
- **GroupAssociations** (*GroupAssociations) - A pointer to the GroupAssociations structure.
```

--------------------------------

### ExtendedMaximumCapacity.String

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Returns a string representation of the ExtendedMaximumCapacity.

```APIDOC
## ExtendedMaximumCapacity.String

### Description
Returns a string representation of the ExtendedMaximumCapacity.

### Method
func (m ExtendedMaximumCapacity) String() string

### Parameters
#### Path Parameters
- **m** (ExtendedMaximumCapacity) - The ExtendedMaximumCapacity value.

### Response
- **string** - The string representation of the ExtendedMaximumCapacity.
```

--------------------------------

### BIOS Language Information Type

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Represents and provides a constructor for SMBIOS BIOS Language Information structures.

```APIDOC
## BIOSLanguageInformation

### Description
Represents the SMBIOS BIOS language information structure, detailing the current and installable languages.

### Fields
- **CurrentLanguage** (string): The currently active language.
- **InstallableLanguages** ([]string): A slice of strings representing all languages that can be installed.
```

```APIDOC
## NewBIOSLanguageInformation

### Description
Initializes and returns a new `BIOSLanguageInformation` struct populated with data from the given SMBIOS structure.

### Signature
```go
func NewBIOSLanguageInformation(s *smbios.Structure) *BIOSLanguageInformation
```

### Parameters
- **s** (*smbios.Structure) - The SMBIOS structure containing BIOS language information.

### Returns
- *BIOSLanguageInformation: A pointer to the initialized `BIOSLanguageInformation` struct.
```

--------------------------------

### MaximumCapacity.String

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Returns a string representation of the MaximumCapacity.

```APIDOC
## MaximumCapacity.String

### Description
Returns a string representation of the MaximumCapacity.

### Method
func (m MaximumCapacity) String() string

### Parameters
#### Path Parameters
- **m** (MaximumCapacity) - The MaximumCapacity value.

### Response
- **string** - The string representation of the MaximumCapacity.
```

--------------------------------

### SystemEnclosure

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Represents the system enclosure information, including manufacturer, version, serial number, and asset tag.

```APIDOC
## SystemEnclosure

### Description
SystemEnclosure represents the system enclosure.

### Fields
- **Manufacturer** (string) - Returns the system enclosure manufacturer.
- **Version** (string) - Returns the system enclosure version.
- **SerialNumber** (string) - Returns the system enclosure serial number.
- **AssetTagNumber** (string) - Returns the system enclosure asset tag number.
- **SKUNumber** (string) - Returns the system enclosure SKU number.
```

```APIDOC
## NewSystemEnclosure

### Description
NewSystemEnclosure initializes and returns a new `SystemEnclosure`.

### Method
```go
func NewSystemEnclosure(s *smbios.Structure) *SystemEnclosure
```

### Parameters
- **s** (*smbios.Structure) - The SMBIOS structure to initialize from.
```

--------------------------------

### WindowsEntryPoint Structure

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios/internal/github.com/digitalocean/go-smbios/smbios

The WindowsEntryPoint structure represents SMBIOS table entry point data specific to Windows systems, as returned by the GetSystemFirmwareTable function. It contains fields for size and version information.

```APIDOC
## type WindowsEntryPoint

```go
type WindowsEntryPoint struct {
	Size         uint32
	MajorVersion byte
	MinorVersion byte
	Revision     byte
}
```

WindowsEntryPoint contains SMBIOS Table entry point data returned from GetSystemFirmwareTable. As raw access to the underlying memory is not given, the full breadth of information is not available.
```

--------------------------------

### BaseboardInformation

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Represents the SMBIOS baseboard information, including manufacturer, product, version, serial number, asset tag, location in chassis, and board type.

```APIDOC
## type BaseboardInformation

### Description
Represents the SMBIOS baseboard information.

### Fields
- **Manufacturer** (string) - The baseboard manufacturer.
- **Product** (string) - The baseboard product.
- **Version** (string) - The baseboard version.
- **SerialNumber** (string) - The baseboard serial number.
- **AssetTag** (string) - The baseboard asset tag.
- **LocationInChassis** (string) - The number of a null-terminated string that describes this board's location within the chassis.
- **BoardType** (BoardType) - Identifies the type of board.
```

--------------------------------

### WakeUpType.String

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Returns a string representation of the WakeUpType.

```APIDOC
## WakeUpType.String

### Description
Returns a string representation of the WakeUpType.

### Method
func (w WakeUpType) String() string

### Parameters
#### Path Parameters
- **w** (WakeUpType) - The WakeUpType value.

### Response
- **string** - The string representation of the WakeUpType.
```

--------------------------------

### TypeDetail.String

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Returns a string representation of the TypeDetail.

```APIDOC
## TypeDetail.String

### Description
Returns a string representation of the TypeDetail.

### Method
func (t TypeDetail) String() string

### Parameters
#### Path Parameters
- **t** (TypeDetail) - The TypeDetail value.

### Response
- **string** - The string representation of the TypeDetail.
```

--------------------------------

### WakeUpType String Method

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Provides a string representation for WakeUpType values. This method is useful for debugging and logging.

```go
func (w WakeUpType) String() string
```

--------------------------------

### Implement Attributes Method for TypeDetail

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Implements the Attributes method for the TypeDetail type. Returns a slice of TypeDetailAttribute representing the SMBIOS memory device detail attributes.

```go
func (t TypeDetail) Attributes() []TypeDetailAttribute
```

--------------------------------

### Stream SMBIOS Data

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios/internal/github.com/digitalocean/go-smbios/smbios

Locates and opens a stream of SMBIOS data and its entry point from the operating system. The returned stream must be closed after use.

```go
func Stream() (io.ReadCloser, EntryPoint, error)
```

--------------------------------

### FormFactor.String

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Returns a string representation of the FormFactor.

```APIDOC
## FormFactor.String

### Description
Returns a string representation of the FormFactor.

### Method
func (f FormFactor) String() string

### Parameters
#### Path Parameters
- **f** (FormFactor) - The FormFactor value.

### Response
- **string** - The string representation of the FormFactor.
```

--------------------------------

### PhysicalMemoryArrayHandle.String

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Returns a string representation of the PhysicalMemoryArrayHandle.

```APIDOC
## PhysicalMemoryArrayHandle.String

### Description
Returns a string representation of the PhysicalMemoryArrayHandle.

### Method
func (p PhysicalMemoryArrayHandle) String() string

### Parameters
#### Path Parameters
- **p** (PhysicalMemoryArrayHandle) - The PhysicalMemoryArrayHandle value.

### Response
- **string** - The string representation of the PhysicalMemoryArrayHandle.
```

--------------------------------

### FormFactor

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Represents the SMBIOS memory device form factor.

```APIDOC
## type FormFactor int

### Description
Represents the SMBIOS memory device form factor.

### Constants
- **FormFactorOther** (FormFactor = 0)
- **FormFactorUnknown** (FormFactor = 1)
- **FormFactorSIMM** (FormFactor = 2)
- **FormFactorSIP** (FormFactor = 3)
- **FormFactorChip** (FormFactor = 4)
- **FormFactorDIP** (FormFactor = 5)
- **FormFactorZIP** (FormFactor = 6)
- **FormFactorProprietaryCard** (FormFactor = 7)
- **FormFactorDIMM** (FormFactor = 8)
- **FormFactorTSOP** (FormFactor = 9)
- **FormFactorRowOfChips** (FormFactor = 10)
- **FormFactorRIMM** (FormFactor = 11)
- **FormFactorSODIMM** (FormFactor = 12)
- **FormFactorSRIMM** (FormFactor = 13)
- **FormFactorFBDIMM** (FormFactor = 14)
- **FormFactorFBDie** (FormFactor = 15)
```

--------------------------------

### GetStringOrEmpty

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Retrieves a string from an SMBIOS structure at a given offset, returning an empty string if not found or invalid.

```APIDOC
## GetStringOrEmpty

### Description
Retrieves a string from an SMBIOS structure at a given offset, returning an empty string if not found or invalid.

### Method
func GetStringOrEmpty(s *smbios.Structure, offset int) string

### Parameters
#### Path Parameters
- **s** (*smbios.Structure) - The SMBIOS structure to read from.
- **offset** (int) - The byte offset within the structure where the string is expected.

### Response
- **string** - The retrieved string or an empty string if the data is invalid.
```

--------------------------------

### TypeDetailAttribute.String

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Returns a string representation of the TypeDetailAttribute.

```APIDOC
## TypeDetailAttribute.String

### Description
Returns a string representation of the TypeDetailAttribute.

### Method
func (t TypeDetailAttribute) String() string

### Parameters
#### Path Parameters
- **t** (TypeDetailAttribute) - The TypeDetailAttribute value.

### Response
- **string** - The string representation of the TypeDetailAttribute.
```

--------------------------------

### SystemSlot

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Represents a SMBIOS system slot, providing its designation.

```APIDOC
## SystemSlot

### Description
SystemSlot represents a SMBIOS system slot.

### Fields
- **SlotDesignation** (string) - Returns the slot designation.
```

```APIDOC
## NewSystemSlot

### Description
NewSystemSlot initializes and returns a new `SystemSlot`.

### Method
```go
func NewSystemSlot(s *smbios.Structure) *SystemSlot
```

### Parameters
- **s** (*smbios.Structure) - The SMBIOS structure to initialize from.
```

--------------------------------

### NewGroupAssociations

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Initializes and returns a new GroupAssociations structure.

```APIDOC
## func NewGroupAssociations

### Description
NewGroupAssociations initializes and returns a new `GroupAssociations`.

### Signature
```go
func NewGroupAssociations(s *smbios.Structure) *GroupAssociations
```
```

--------------------------------

### MemoryArrayLocation Enumeration

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Defines the possible locations for a memory array. Includes constants for various physical and logical locations.

```go
type MemoryArrayLocation int

const (
	// MemoryArrayLocationOther is a memory array location type.
	MemoryArrayLocationOther MemoryArrayLocation = iota
	// MemoryArrayLocationUnknown is a memory array location type.
	MemoryArrayLocationUnknown
	// MemoryArrayLocationSystemBoard is a memory array location type.
	MemoryArrayLocationSystemBoard
	// MemoryArrayLocationISAAddon is a memory array location type.
	MemoryArrayLocationISAAddon
	// MemoryArrayLocationEISAAddon is a memory array location type.
	MemoryArrayLocationEISAAddon
	// MemoryArrayLocationPCIAddon is a memory array location type.
	MemoryArrayLocationPCIAddon
	// MemoryArrayLocationMCAAddon is a memory array location type.
	MemoryArrayLocationMCAAddon
	// MemoryArrayLocationPCMCIAAddon is a memory array location type.
	MemoryArrayLocationPCMCIAAddon
	// MemoryArrayLocationProprietaryAddon is a memory array location type.
	MemoryArrayLocationProprietaryAddon
	// MemoryArrayLocationNuBus is a memory array location type.
	MemoryArrayLocationNuBus
	// MemoryArrayLocationPC98C20Addon is a memory array location type.
	MemoryArrayLocationPC98C20Addon
	// MemoryArrayLocationPC98C24Addon is a memory array location type.
	MemoryArrayLocationPC98C24Addon
	// MemoryArrayLocationPC98EAddon is a memory array location type.
	MemoryArrayLocationPC98EAddon
	// MemoryArrayLocationPC98LocalBusAddon is a memory array location type.
	MemoryArrayLocationPC98LocalBusAddon
)
```

--------------------------------

### String Representation of MaximumCapacity

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Returns the string representation of a `MaximumCapacity` value.

```go
func (m MaximumCapacity) String() string
```

--------------------------------

### Decoder

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios/internal/github.com/digitalocean/go-smbios/smbios

A Decoder is used to decode SMBIOS Structures from a stream. Use NewDecoder to create a Decoder instance.

```APIDOC
## func NewDecoder(r io.Reader) *Decoder

NewDecoder creates a Decoder which decodes Structures from the input stream.
```

```APIDOC
## func (d *Decoder) Decode() ([]*Structure, error)

Decode decodes Structures from the Decoder's stream until an End-of-table structure is found.
```

--------------------------------

### MemoryDeviceVoltage.String

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Returns a string representation of the MemoryDeviceVoltage.

```APIDOC
## MemoryDeviceVoltage.String

### Description
Returns a string representation of the MemoryDeviceVoltage.

### Method
func (m MemoryDeviceVoltage) String() string

### Parameters
#### Path Parameters
- **m** (MemoryDeviceVoltage) - The MemoryDeviceVoltage value.

### Response
- **string** - The string representation of the MemoryDeviceVoltage.
```

--------------------------------

### MemoryArrayUse.String

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Returns a string representation of the MemoryArrayUse.

```APIDOC
## MemoryArrayUse.String

### Description
Returns a string representation of the MemoryArrayUse.

### Method
func (m MemoryArrayUse) String() string

### Parameters
#### Path Parameters
- **m** (MemoryArrayUse) - The MemoryArrayUse value.

### Response
- **string** - The string representation of the MemoryArrayUse.
```

--------------------------------

### SMBIOS Structure Definition

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios

Defines the structure for SMBIOS data, including header, formatted bytes, and strings. The 'Formatted' section excludes the header, and 'Strings' are only present for fields of type 'STRING'.

```go
type Structure struct {
  Header    Header
  Formatted []byte
  Strings   []string
}

```

--------------------------------

### BoardType

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Defines the board type enum for SMBIOS.

```APIDOC
## type BoardType int

### Description
Defines the board type enum.

### Constants
- **BoardTypeUnknown** (BoardType = 0)
- **BoardTypeOther** (BoardType = 1)
- **BoardTypeServerBlade** (BoardType = 2)
- **BoardTypeConnectivitySwitch** (BoardType = 3)
- **BoardTypeSystemManagementModule** (BoardType = 4)
- **BoardTypeProcessorModule** (BoardType = 5)
- **BoardTypeIOModule** (BoardType = 6)
- **BoardTypeMemoryModule** (BoardType = 7)
- **BoardTypeDaughterBoard** (BoardType = 8)
- **BoardTypeMotherboard** (BoardType = 9)
- **BoardTypeProcessorMemoryModule** (BoardType = 10)
- **BoardTypeProcessorIOModule** (BoardType = 11)
- **BoardTypeInterconnectBoard** (BoardType = 12)
```

--------------------------------

### TypeDetail

Source: https://pkg.go.dev/github.com/siderolabs/go-smbios/smbios

Represents the SMBIOS memory device detail.

```APIDOC
## TypeDetail

### Description
TypeDetail represents the SMBIOS memory device detail.
```

```APIDOC
## Attributes

### Description
Attributes returns the SMBIOS memory device detail attribute.

### Method
```go
func (t TypeDetail) Attributes() []TypeDetailAttribute
```

### Returns
- **[]TypeDetailAttribute** - A slice of TypeDetailAttribute representing the memory device attributes.
```

```APIDOC
## String

### Description
String returns a string representation of the TypeDetail.

### Method
```go
func (t TypeDetail) String() string
```

### Returns
- **string** - The string representation of the TypeDetail.
```
Tokens:
Raw