align

Documentation

Overview

Package align provides helpers for doing uint alignment.

alignment is done via bit operation at the moment, so alignment size need be a power of 2.

Package align provides helpers for doing uint alignment.

Index

• func Down[T constraints.Unsigned](v T, alignSize T) T
• func DownPage[T constraints.Unsigned](v T) T
• func IsAligned[T constraints.Unsigned](v T, alignSize T) bool
• func Up[T constraints.Unsigned](v T, alignSize T) T
• func UpPage[T constraints.Unsigned](v T) T

Functions

func Down

func Down[T constraints.Unsigned](v T, alignSize T) T

Down aligns v down to a previous multiple of alignSize.

alignSize need be a power of 2.

func DownPage

func DownPage[T constraints.Unsigned](v T) T

DownPage aligns v down by system page size.

func IsAligned

func IsAligned[T constraints.Unsigned](v T, alignSize T) bool

IsAligned checks whether v is aligned to alignSize.

alignSize need be a power of 2.

func Up

func Up[T constraints.Unsigned](v T, alignSize T) T

Up aligns v up to next multiple of alignSize.

alignSize need be a power of 2.

func UpPage

func UpPage[T constraints.Unsigned](v T) T

UpPage aligns v up by system page size.