Interface.swift

//===----------------------------------------------------------------------===//
// Copyright © 2025 Apple Inc. and the Containerization project authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//===----------------------------------------------------------------------===//

/// A network interface.
public protocol Interface: Sendable {
    /// The interface IPv4 address and subnet prefix length, as a CIDR address.
    /// Example: `192.168.64.3/24`
    var address: String { get }

    /// The IP address for the default route, or nil for no default route.
    var gateway: String? { get }

    /// The interface MAC address, or nil to auto-configure the address.
    var macAddress: String? { get }
}