Skip to content

Interfaces e Enums ​

tyrus:os exporta quatro enums nativos e oito interfaces nativas.

Interfaces precisam ser importadas pelo nome

Diferente dos enums abaixo, UserInfo, CpuInfo, BatteryInfo, NetworkInterface, OsError, NotifyOptions, FontInfo e Color não ficam disponíveis até o arquivo importá-las explicitamente, import { CpuInfo, cpus } from "tyrus:os";, não só cpus. Isso vale mesmo sem escrever o nome do tipo numa anotação: const cores = cpus(); cores[0].model ainda exige CpuInfo importado, já que resolver .model precisa da lista de campos dela.

OsPlatform e OsArch ​

OsPlatform e OsArch são devolvidos por platform() e arch(). Ambos refletem o alvo para o qual este binário foi compilado, não um palpite em tempo de execução.

tyrus
import { arch, platform } from "tyrus:os";
import { OsArch, OsPlatform } from "tyrus:os";

const currentPlatform: OsPlatform = platform();
const currentArch: OsArch = arch();

print(currentPlatform === OsPlatform.Linux);
print(currentArch === OsArch.X86_64);

Membros de OsPlatform ​

MembroSignificado
LinuxLinux
MacOSmacOS
WindowsWindows
OtherQualquer outro alvo

Membros de OsArch ​

MembroSignificado
X86_64x86 64-bit
Aarch64ARM 64-bit
X86x86 32-bit
ArmARM 32-bit
OtherQualquer outro alvo

NotifyUrgency ​

NotifyUrgency é o campo urgency de NotifyOptions, passado para notify().

Membros de NotifyUrgency ​

MembroSignificado
LowPrioridade baixa, o ambiente de desktop pode nem mostrar em modo "não perturbe".
NormalPrioridade padrão.
CriticalPrioridade alta, alguns ambientes de desktop mantêm na tela até ser dispensada.

SystemCapability ​

SystemCapability é o tipo do argumento de hasCapability(): cada membro responde "dá pra descobrir?"/"isso funcionaria?" para um canto de tyrus:os, sem disparar o efeito real.

Membros de SystemCapability ​

MembroSignificado
NotificationSe uma notificação de desktop poderia plausivelmente ser mostrada.
ClipboardSe a área de transferência do sistema pode ser alcançada.
BatterySe esta máquina reporta pelo menos uma bateria.
DarkModeSe a configuração de modo escuro do desktop é consultável.
ScreenLockSe o estado de proteção de tela/tela de bloqueio é consultável (só Linux).
SessionLockSe o estado de bloqueio de sessão é consultável (só Linux).
SleepPreventionSe preventSleep()/allowSleep() realmente funcionariam.
FontsSe systemFonts() retornaria alguma coisa.

UserInfo ​

UserInfo é devolvido por userInfo(): o login, o diretório home e o shell do usuário ativo numa única chamada.

tyrus
import { UserInfo, userInfo } from "tyrus:os";

const info: UserInfo = userInfo();
print(info.username);
print(info.homedir);
print(info.shell);

Campos de UserInfo ​

CampoTipoSignificado
usernamestringO nome de login (igual a userName()).
homedirstringO diretório home (igual a homeDir()).
shellstringO shell padrão do usuário.

CpuInfo ​

CpuInfo é o tipo dos elementos do array devolvido por cpus(): uma entrada por núcleo lógico de CPU.

tyrus
import { CpuInfo, cpus } from "tyrus:os";

const cores: CpuInfo[] = cpus();
print(`${cores.length} cores, ${cores[0].model}`);

Campos de CpuInfo ​

CampoTipoSignificado
modelstringO nome do modelo da CPU (ex.: "Intel(R) Core(TM) i5-10400F CPU @ 2.90GHz").
speedu32A frequência do núcleo, em MHz.

BatteryInfo ​

BatteryInfo é devolvido por battery().

tyrus
import { BatteryInfo, battery } from "tyrus:os";

const info: BatteryInfo? = battery();
if (info) {
    print(`${info.level * 100.0}%, charging: ${info.charging}`);
}

Campos de BatteryInfo ​

CampoTipoSignificado
levelf32Estado de carga, de 0.0 a 1.0.
chargingbooleanSe a bateria está carregando no momento.
timeToFullu32?Segundos até completar a carga, ausente a menos que esteja carregando.
timeToEmptyu32?Segundos até esgotar, ausente a menos que esteja descarregando.

NetworkInterface ​

NetworkInterface é o tipo dos elementos do array devolvido na variante Ok por networkInterfaces(): uma entrada por endereço IP local, então uma placa com endereço IPv4 e IPv6 contribui com duas entradas.

tyrus
import { NetworkInterface, OsError, networkInterfaces } from "tyrus:os";

const result: Result<NetworkInterface[], OsError> = networkInterfaces();
match (result) {
    Ok(interfaces) => { print(`${interfaces.length} address(es)`); }
    Err(error) => { printError(error.code); }
}

Campos de NetworkInterface ​

CampoTipoSignificado
namestringO nome da placa (ex.: "eth0", "en0", "Wi-Fi").
addressstringO endereço IP local.
netmaskstringA máscara de sub-rede de address.
familystring"IPv4" ou "IPv6".

OsError ​

OsError é retornado na variante Err por openUrl(), trash(), preventSleep(), allowSleep() e networkInterfaces() quando uma operação falha, com um code estável e estruturado e uma message legível.

OsError é um Error: um catch (error) sem anotação o recebe, e error is OsError estreita o binding para ele, com todos os campos de OsError.

Campos de OsError ​

CampoTipoSignificado
codestringUm identificador estável e legível por máquina (ex.: "ERR_OS_NO_HANDLER").
messagestringUma descrição legível do que deu errado.

NotifyOptions ​

NotifyOptions é o terceiro argumento opcional de notify(). Todo campo é opcional; um campo omitido usa o padrão da própria plataforma.

Campos de NotifyOptions ​

CampoTipoSignificado
iconstring?O nome ou caminho de um ícone para mostrar junto da notificação.
urgencyNotifyUrgency?Veja NotifyUrgency. Padrão é Normal.
timeoutu32?Por quanto tempo a notificação fica visível, em milissegundos, antes do ambiente de desktop dispensá-la automaticamente.

FontInfo ​

FontInfo é o tipo do elemento do array retornado por systemFonts(): uma entrada por face de fonte, então uma família com variantes regular/bold/italic/bold-italic contribui com uma entrada por variante.

tyrus
import { FontInfo, systemFonts } from "tyrus:os";

const fonts: FontInfo[] = systemFonts();
print(`${fonts.length} faces installed`);
if (fonts.length > 0) {
    print(`${fonts[0].name} (${fonts[0].style})`);
}

Campos de FontInfo ​

CampoTipoSignificado
namestringO nome de família primário da face.
stylestring"normal", "italic", ou "oblique".
pathstringO caminho do arquivo de fonte, ou uma string vazia para uma fonte embutida em memória em vez de apoiada por um arquivo.

Color ​

Color é o tipo do argumento de accessibleColorContrast(), construído como um object literal simples, do mesmo jeito que NotifyOptions.

Campos de Color ​

CampoTipoSignificado
ru8O canal vermelho, de 0 a 255.
gu8O canal verde, de 0 a 255.
bu8O canal azul, de 0 a 255.